Developer CD Series 1996 April: Mac OS SDK

home *** CD-ROM | disk | FTP | other *** search

/ Developer CD Series 1996 April: Mac OS SDK / Dev.CD Apr 96 SDK / Dev.CD Apr 96 SDK1.toast / Development Kits (Disc 1) / OpenDoc / Navigation Tools / 411 / OpenDocHelp < prev next >

Wrap

Text File | 1995-10-18 | 986.9 KB | 47,255 lines | [TEXT/MPS ]

æKY CopyrightNotice æC Copyright Apple Computer, Inc. 1992-1994, All rights reserved. 411 - OpenDoc™ Help - OpenDoc™ 1.0 Alpha 6 Release. Exported from OD API Documentation System written by Tantek Çelik Wednesday, October 18, 1995 10:42:34 AM æKY OpenDocHelp OpenDoc æKL ODArbitratorHelp ODBindingHelp ODCanvasHelp ODClipboardHelp ODConstantsHelp ODContainerHelp ODCPlusSemanticInterfaceHelp ODDescHelp ODDispatcherHelp ODDispatchModuleHelp ODDocumentHelp ODDraftHelp ODDragAndDropHelp ODDragItemIteratorHelp ODEmbeddedFramesIteratorHelp ODExtensionHelp ODFacetHelp ODFacetIteratorHelp ODFocusModuleHelp ODFocusOwnerIteratorHelp ODFocusSetHelp ODFocusSetIteratorHelp ODFrameHelp ODFrameFacetIteratorHelp ODInfoHelp ODLinkHelp ODLinkIteratorHelp ODLinkManagerHelp ODLinkSourceHelp ODLinkSourceIteratorHelp ODLinkSpecHelp ODMenuBarHelp ODMessageInterfaceHelp ODNameResolverHelp ODNameSpaceHelp ODNameSpaceManagerHelp ODObjectHelp ODObjectIteratorHelp ODObjectNameSpaceHelp ODOSLTokenHelp ODPartHelp ODPartWrapperHelp ODPersistentObjectHelp ODPlatformTypeListHelp ODPlatformTypeListIteratorHelp ODRefCntObjectHelp ODSemanticInterfaceHelp ODSessionHelp ODSettingsExtensionHelp ODShapeHelp ODShellPlugInHelp ODSIHelperHelp ODSIHelperAbsHelp ODStorageSystemHelp ODStorageUnitHelp ODStorageUnitCursorHelp ODStorageUnitRefIteratorHelp ODStorageUnitViewHelp ODTransformHelp ODTranslationHelp ODTypeListHelp ODTypeListIteratorHelp ODTypesHelp ODUndoHelp ODValueIteratorHelp ODValueNameSpaceHelp ODWindowHelp ODWindowIteratorHelp ODWindowStateHelp æKY ODArbitratorHelp ODArbitrator Arbitrator æKL ODArbitrator::ODArbitrator ODArbitrator::~ODArbitrator ODArbitrator::CreateFocusSet ODArbitrator::CreateOwnerIterator ODArbitrator::GetFocusModule ODArbitrator::GetFocusOwner ODArbitrator::InitArbitrator ODArbitrator::IsFocusExclusive ODArbitrator::IsFocusRegistered ODArbitrator::Purge ODArbitrator::RegisterFocus ODArbitrator::RelinquishFocus ODArbitrator::RelinquishFocusSet ODArbitrator::RequestFocus ODArbitrator::RequestFocusSet ODArbitrator::TransferFocus ODArbitrator::TransferFocusSet ODArbitrator::UnregisterFocus ODArbitrator::fFocusModules ODArbitrator::fSession æC Basic Class Documentation The Arbitrator is used to manage competition between parts for named resources known as "foci". The parts in an OpenDoc document communicate with a single ODArbitrator object, obtained from the ODSession object. ODArbitrator is a subclass of ODObject. ODArbitrator is a platform-independent class. Related classes are ODFocusModule, ODFocusSet, and ODFocusSetIterator. ODArbitrator participates in the Part Activation and UI Events protocols. Theory of Operation The arbitrator is used to manage competition between parts for named resources known as "foci". The foci are described by segmented ISO strings, but most arbitration methods used tokenize forms of these. The Session object has a Tokenize() method. Most foci are exclusive, and can only be "owned" by a single part at a time. However the arbitrator also supports non exclusive foci which can be owned by several parts. In this case, all the arbitrator does is provide a central place to record and obtain the list of owners of a focus. Example foci include keystroke focus, selection focus, and menu bar focus. Keyboard events are sent to the part which has the keystroke focus. Menu events are sent to the part which has the menu bar focus (assuming there is a menu bar on a particular platform). Many foci are related to event distribution within an OpenDoc document, but foci could also be associated with system-wide resources like ports. A part typically requests and relinquishes a set of foci from the arbitrator. What the user thinks of as the "active" part is really the part which owns the selection focus. Don't worry. The same part will almost always also own the menu bar and keystroke foci, but it is possible, in principle, for one part to receive menu commands while another gets keystrokes. This may make sense in a dialog part which is built from control parts with which it has a more intimate relationship than the usual one between containers and embedded parts. The arbitrator is extensible, to accomodate the addition of exotic input devices, and parts which use them. The arbitrator contains a collection of focus modules (instances of subclasses of ODFocusModule). Additional focus modules can be installed to handle new focus types. Invariants Maintained by Class ODArbitrator maintains a table associating foci with focus modules. There is a standard focus module which arbitrates the standard foci like keystroke focus and menu bar focus. Other Persistent Properties No persistent properties æKY ODArbitrator::ODArbitrator Arbitrator::ODArbitrator Arbitrator->ODArbitrator æT Class Method æD ODArbitrator(); æC Protection Public. The arbitrator is created by the OpenDoc session object. Parts do not create instances of this class. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Initializes the fields of the instance to safe defaults. Initialization that might fail is done in InitArbitrator(). Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions Arbitrator is constructed, but not yet usable, because InitArbitrator must be called. æKY ODArbitrator::~ODArbitrator Arbitrator::~ODArbitrator Arbitrator->~ODArbitrator æT Class Method æD ~ODArbitrator(); æC Protection Public. The arbitrator is destroyed by the OpenDoc session object. Parts do not destroy arbitrators. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Frees the memory allocated by this object. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions A valid instance Post conditions The memory used by the instance is freed, and the instance is no longer usable. æKY ODArbitrator::CreateFocusSet Arbitrator::CreateFocusSet Arbitrator->CreateFocusSet æT Class Method æD ODFocusSet CreateFocusSet(); æC Protection Public. Will be called by most part editors. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns an initialized instance of ODFocusSet. Parts use this to create a focus set to pass to RequestFocusSet, after adding foci to it. Inputs None. Outputs <return> An initialized focus set. Exceptions Signalled kODErrOutOfMemory Out of memory Pre conditions A valid initialized ODArbitrator. Post conditions Result contains initialized ODFocusSet instance. æKY ODArbitrator::CreateOwnerIterator Arbitrator::CreateOwnerIterator Arbitrator->CreateOwnerIterator æT Class Method æD ODFocusOwnerIterator* CreateOwnerIterator( ODTypeToken focus); æC Protection Public. Can be called by part editors. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns an iterator which returns all the parts which own the specified non-exclusive focus. Inputs focus A token for a registered focus type. Outputs <return> An iterator Exceptions Signalled kODErrOutOfMemory Out of memory Pre conditions A valid non-exclusive focus. Post conditions No change in internal state. æKY ODArbitrator::GetFocusModule Arbitrator::GetFocusModule Arbitrator->GetFocusModule æT Class Method æD ODFocusModule GetFocusModule( in ODTypeToken focusType); æC Protection Public. Not called by most part editors. Can be used to "patch" focus modules by saving the old one and calling it from a new one. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the focus module associated with the specified focus, or kODNULL. Inputs focusType A token for a registered focus type. Outputs <return> The focus module for the specified focus. May be kODNull. Exceptions Signalled None. Pre conditions A valid focus. Post conditions The focus module is returned. æKY ODArbitrator::GetFocusOwner Arbitrator::GetFocusOwner Arbitrator->GetFocusOwner æT Class Method æD ODFrame* GetFocusOwner( ODTypeToken focusType); æC Protection Public. Called by part editors. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the frame which owns the specified focus, or kODNULL. Inputs focusType A token for a registered focus type. Outputs <return> The frame which owns the focus. May be kODNull. Exceptions Signalled None. Pre conditions A valid focus. Post conditions The owning frame is returned. æKY ODArbitrator::InitArbitrator Arbitrator::InitArbitrator Arbitrator->InitArbitrator æT Class Method æD void InitArbitrator( ODSession* session); æC Protection Public. The arbitrator is created by the OpenDoc session object. Parts do not call this method. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Performs initialization that could fail. Inputs None Outputs None Exceptions Signalled kODErrorOutOfMemory Out of memory. Pre conditions None. Post conditions An initialized, usable arbitrator. æKY ODArbitrator::IsFocusExclusive Arbitrator::IsFocusExclusive Arbitrator->IsFocusExclusive æT Class Method æD ODBoolean IsFocusExclusive( ODTypeToken focus); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns kODTrue, if the specified focus is exclusive, kODFalse otherwise. Inputs focus A token for a registered focus Outputs <return> kODTrue, if the focus is exclusive Exceptions Signalled None. Pre conditions A constructed and initialized object of this class. Post conditions Result contains kODTrue if the specified focus is exclusive, kODFalse otherwise. æKY ODArbitrator::IsFocusRegistered Arbitrator::IsFocusRegistered Arbitrator->IsFocusRegistered æT Class Method æD ODBoolean IsFocusRegistered( ODTypeToken focus); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns kODTrue, if the specified focus is registered, kODFalse otherwise. Inputs focus A token for a registered focus Outputs <return> kODTrue, if the focus is registered Exceptions Signalled None. Pre conditions A constructed and initialized object of this class. Post conditions Result contains kODTrue if the specified focus is exclusive, kODFalse otherwise. æKY ODArbitrator::Purge Arbitrator::Purge Arbitrator->Purge æT Class Method æD ODSize Purge( ODSize size); æC Protection Public. Called by OpenDoc in low memory situations. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Frees up some memory, usually by flushing internal state to external storage. Inputs size The amount of memory requested. Outputs <return> The amount of memory freed. Exceptions Signalled None. Pre conditions A valid initialized instance Post conditions Some memory has been freed up. æKY ODArbitrator::RegisterFocus Arbitrator::RegisterFocus Arbitrator->RegisterFocus æT Class Method æD void RegisterFocus( ODTypeToken focus, ODFocusModule* focusModule); æC Protection Public. Called by some part editors. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Installs a new focus module to be used to manage the specified focus. Inputs focus A token for a focus to be managed by the specified focus module. focusModule A focus module to be associated with the specified focus. Outputs None. Exceptions Signalled kODErrExistingFocusModule A focus module already exists for that focus. Pre conditions A valid focus and focus module Post conditions The table contains the new focus module. æKY ODArbitrator::RelinquishFocus Arbitrator::RelinquishFocus Arbitrator->RelinquishFocus æT Class Method æD void RelinquishFocus( ODTypeToken focus, ODFrame* relinquishingFrame); æC Protection Public. Called by part editors. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Sets the owner frame of the specified focus to kODNULL. Inputs focus A focus to be relinquished. relinquishingFrame The frame which is relinquishing ownership of the focus. Outputs None. Exceptions Signalled kODErrInvalidFrame Pre conditions A valid focus and relinquishing frame are required. Post conditions The focus now has no owner. æKY ODArbitrator::RelinquishFocusSet Arbitrator::RelinquishFocusSet Arbitrator->RelinquishFocusSet æT Class Method æD void RelinquishFocusSet( ODFocusSet* focusSet, ODFrame* relinquishingFrame); æC Protection Public. Called by part editors. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Sets the owner frame of each focus in the specified focus set to kODNULL. Inputs focusSet A set of foci to be relinquished. relinquishingFrame The frame which is relinquishing ownership of the set of foci. Outputs None. Exceptions Signalled kODErrInvalidFocusSet kODErrInvalidFrame Pre conditions A valid focus set and relinquishing frame are required. Post conditions Each focus now in the set now has no owner. æKY ODArbitrator::RequestFocus Arbitrator::RequestFocus Arbitrator->RequestFocus æT Class Method æD ODBoolean RequestFocus( ODTypeToken focus, ODFrame* requestingFrame); æC Protection Public. Called by part editors, which generally use RequestFocusSet, but use this method when a single focus is requested. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Ownership of the specified focus is assigned to the specified frame, provided the existing owner was willing to relinquish the requested focus. Inputs focus A requested focus. requestingFrame The frame requesting the focus. Outputs <return> kODTrue, if the request was granted. Exceptions Signalled kODErrFocusNotRegistered One of the requested foci is not registered. Pre conditions A valid focus, and requesting frame. Post conditions If the request is granted, the new ownership relationship is stored in the relevant focus module, and kODTrue is returned. If the request fails, the existing ownership relationship is intact, and kODFalse is returned. æKY ODArbitrator::RequestFocusSet Arbitrator::RequestFocusSet Arbitrator->RequestFocusSet æT Class Method æD ODBoolean RequestFocusSet( ODFocusSet* focusSet, ODFrame* requestingFrame); æC Protection Public. Called by part editors. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Ownership of each focus in the specified focus set is assigned to the specified frame, provided all existing owners were willing to relinquish the requested foci. The operation is atomic. If one focus is unattainable ownership of the set is not granted. Inputs focusSet A set of requested foci. requestingFrame The frame requesting the focus. Outputs <return> kODTrue, if the request was granted. Exceptions Signalled kODErrFocusNotRegistered One of the requested foci is not registered. Pre conditions A valid focus set, and requesting frame. Post conditions If the request is granted, the new ownership relationships are stored in the relevant focus modules, and kODTrue is returned. If the request fails, the existing ownership relationships are intact, and kODFalse is returned. æKY ODArbitrator::TransferFocus Arbitrator::TransferFocus Arbitrator->TransferFocus æT Class Method æD void TransferFocus( ODTypeToken focus, ODFrame* transferringFrame, ODFrame* newOwner); æC Protection Public. Called by part editors, for example when transferring the modal focus back to its previous owner. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Transfers a focus from its current owner to another. The new owner's FocusAcquired() method is called. If the existing owner is not the transferring frame, its FocusLost() method is also called. Inputs focus A focus to be relinquished. transferringFrame The frame which is transferring ownership of the focus. Need not be the current owner. newOwner The new focus owner Outputs None. Exceptions Signalled kODErrInvalidFrame Pre conditions The focus is registered. Post conditions The focus is owned by "newOwner". æKY ODArbitrator::TransferFocusSet Arbitrator::TransferFocusSet Arbitrator->TransferFocusSet æT Class Method æD void TransferFocusSet( ODFocusSet* focusSet, ODFrame* transferringFrame, ODFrame* newOwner); æC Protection Public. Can be called by part editors. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Sets the owner frame of each focus in the specified focus set to newFrame. The new owner's FocusAcquired() method is called. If the existing owner is not the transferring frame, its FocusLost() method is also called. Inputs focusSet A set of foci to be relinquished. transferringFrame The frame which is transferring ownership of the set of foci. newOwner The new frame which owns the focus set Outputs None. Exceptions Signalled kODErrInvalidFocusSet kODErrInvalidFrame Pre conditions The foci are registered Post conditions The foci are owned by "newFrame" æKY ODArbitrator::UnregisterFocus Arbitrator::UnregisterFocus Arbitrator->UnregisterFocus æT Class Method æD void UnregisterFocus( ODTypeToken focus); æC Protection Public. Called by some part editors. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Removes the specified focus module from the table. Inputs focus A token for a focus to be removed. Outputs None. Exceptions Signalled None. Pre conditions A valid focus and focus module. Post conditions The specified focus module is not in the table. æKY ODArbitrator::fFocusModules Arbitrator::fFocusModules æT Class Field æD DictionaryList* fFocusModules; æC æKY ODArbitrator::fSession Arbitrator::fSession æT Class Field æD ODSession* fSession; // Access to globals æC æKY ODBindingHelp ODBinding Binding æKL ODBinding::ODBinding ODBinding::~ODBinding ODBinding::ChooseEditorForPart ODBinding::GetContainerSuite ODBinding::InitBinding ODBinding::Purge ODBinding::fBinding ODBinding::fSession æC Basic Class Documentation This class represents the OpenDoc Name Binding object. Objects of this class are created by member functions of the ODSession class. ODBinding is a subclass of ODObject. Theory of Operation Invariants Maintained by Class æKY ODBinding::ODBinding Binding::ODBinding Binding->ODBinding æT Class Method æD ODBinding(); æC Protection Private. Only to be called by ODBaseSession::ODBaseSession(). Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Initialize an ODNameSpace class Inputs None Outputs None Exceptions Signalled None. Pre conditions None. Post conditions An ODBinding class will be created. æKY ODBinding::~ODBinding Binding::~ODBinding Binding->~ODBinding æT Class Method æD virtual ~ODBinding(); æC Protection Private. Only to be called by the ODBaseSession class. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Destroys the ODBinding object and any associated storage. Inputs None Outputs None Exceptions Signalled None. Pre conditions None. Post conditions Object destroyed. æKY ODBinding::ChooseEditorForPart Binding::ChooseEditorForPart Binding->ChooseEditorForPart æT Class Method æD ODEditor ChooseEditorForPart( ODStorageUnit thePartSU, ODType newKind); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns a part class id to be used for part instantiation by name. Inputs thePartSU The StorageUnit of the part being instantiated. newKind When the StorageUnit is NULL, pass in a kind for the new part. Outputs Return Part Editor class id. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODBinding::GetContainerSuite Binding::GetContainerSuite Binding->GetContainerSuite æT Class Method æD ODContainerSuite GetContainerSuite( ODContainerType containerType); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns a container suite class id to be used for instantiating a container suite by name. Inputs containerType The container suite type. Outputs Return container suite class id. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODBinding::InitBinding Binding::InitBinding Binding->InitBinding æT Class Method æD void Initialize( ODSession session); æC Protection Private. Should only be called by ODBaseSession. Override policy Derived class cannot override. Derived class cannot call base class behavior, before derived class behavior. Basic operation Initializes the ODBinding object. Inputs session The session that the Binding object belongs to. Outputs None. Exceptions Signalled kODErrOutOfMemory Out of memory. Pre conditions None. Post conditions The ODBinding object will be initialized. æKY ODBinding::Purge Binding::Purge Binding->Purge æT Class Method æD ODSize Purge( ODSize howMuch); æC Protection Public. Override policy Derived class can override. Derived class must call base class behavior, during derived class behavior. Basic operation Frees up unused memory. Inputs howMuch The amount of memory to purge. Outputs Return The amount of memory that was freed. Exceptions Signalled None. Pre conditions None. Post conditions Some memory may be freed for use. æKY ODBinding::fBinding Binding::fBinding æT Class Field æD Binding* fBinding; æC æKY ODBinding::fSession Binding::fSession æT Class Field æD ODSession fSession; æC Persistent form None. æKY ODCanvasHelp ODCanvas Canvas æKL ODCanvas::CheckUpdateShape ODCanvas::GetBiasTransform ODCanvas::GetFacet ODCanvas::GetGraphicsSystem ODCanvas::GetOwner ODCanvas::GetPlatformCanvas ODCanvas::GetPlatformPrintJob ODCanvas::GetUpdateShape ODCanvas::HasPlatformCanvas ODCanvas::HasPlatformPrintJob ODCanvas::InitCanvas ODCanvas::Invalidate ODCanvas::IsDynamic ODCanvas::IsOffscreen ODCanvas::Purge ODCanvas::ResetUpdateShape ODCanvas::SetBiasTransform ODCanvas::SetFacet ODCanvas::SetOwner ODCanvas::SetPlatformCanvas ODCanvas::SetPlatformPrintJob ODCanvas::somInit ODCanvas::somUninit ODCanvas::Validate æC Basic Class Documentation Ancestors: ODCanvas -> ODObject ODCanvas objects are wrappers for platform-specific data structures representing drawing environments. OpenDoc makes few assumptions about the underlying drawing environment of a canvas. A canvas can hold anything from a bitmap or a structured display list to a stream of PostScript code. The "graphicsSystem" code indicates which kind of platform data structure is encapsulated by the canvas object. Part editors will use the standard platform drawing calls for the appropriate graphics system to render their contents on the canvas. The "platformCanvas" field holds a reference to the platform data structure. It is NOT disposed of when the canvas object is deleted; it is the canvas' owner's responsibility to do that. A canvas can be used several different ways. The "isDynamic" flag indicates whether the canvas represents a dynamic environment like a window or bitmap, or a static environment like a printed page. Part editors will display parts differently based on that distinction. For instance, a part may have scroll bars on the screen, but not when printed. Part editors may also use different drawing commands for printing or screen display. The "isOffscreen" flag indicates whether the canvas is the main canvas of the window (or print job), or use for off-screen rendering. Offscreen canvases can be created by parts which wish to do double-buffering, image combination such as tinting or translucency, etc. Parts embedded on offscreen canvases have to do little to no extra work to display properly. Offscreen canvases also maintain an update shape describing the area of the canvas which is invalid and needs to be redrawn, just like most platforms' windows do. This lets embedded parts interact with their drawing environment the same way whether in the window's canvas or offscreen. An offscreen canvas is attached to a particular facet. The canvas has a back-pointer to that facet, and also a reference to the part that created it. That part is responsible for moving the contents of the canvas to its parent canvas when updating. Theory of Operation Invariants Maintained by Class The canvas is created with a particular platformCanvas in a particular graphics system. These values will never change. The isDynamic and isOffscreen flags are also set for the lifetime of the object. æKY ODCanvas::CheckUpdateShape Canvas::CheckUpdateShape Canvas->CheckUpdateShape æT Class Method æD void CheckUpdateShape(); æC Protection Protected. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation This is a vestigial method that is unused and should not be called. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODCanvas::GetBiasTransform Canvas::GetBiasTransform Canvas->GetBiasTransform æT Class Method æD ODTransform* GetBiasTransform(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the bias transform associated with this canvas (see SetBiasTransform). If none has previously been set, this method returns NULL. The caller must not modify or delete this transform; if you want to change it, copy it, modify the copy, and call SetBiasTransform to install the copy. This method increments the ref-count of the transform. The caller must release it when done with it. Inputs None. Outputs <return> The canvas' bias transform object. Read-only! Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODCanvas::GetFacet Canvas::GetFacet Canvas->GetFacet æT Class Method æD ODFacet* GetFacet(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the facet this canvas is associated with. Inputs None. Outputs <return> This canvas' facet. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODCanvas::GetGraphicsSystem Canvas::GetGraphicsSystem Canvas->GetGraphicsSystem æT Class Method æD ODGraphicsSystem GetGraphicsSystem(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the code indicating the graphics system of this canvas. Inputs None. Outputs <return> Graphics system code. Potential values are platform-dependent. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODCanvas::GetOwner Canvas::GetOwner Canvas->GetOwner æT Class Method æD ODPart* GetOwner(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the part which is responsible for copying this canvas' image to its parent canvas. The caller must release the part when done with it. Inputs None. Outputs <return> The owner part. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODCanvas::GetPlatformCanvas Canvas::GetPlatformCanvas Canvas->GetPlatformCanvas æT Class Method æD ODPlatformCanvas GetPlatformCanvas( ODGraphicsSystem ); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, before derived class behavior. Basic operation Return the platform canvas of this canvas, for the desired graphics system. If none exists, an exception will be raised. The graphics system must be specified since, in some implementations (such as the Mac) canvases can store platformCanvases for two graphics systems (such as QuickDraw and QuickDraw GX) simultaneously. Inputs None. Outputs <return> Pointer to the platform-specific canvas. Exceptions Signalled kODErrInvalidGraphicsSystem The graphics system is unknown; or there is no platform canvas associated with this graphics system. Pre conditions None. Post conditions None. æKY ODCanvas::GetPlatformPrintJob Canvas::GetPlatformPrintJob Canvas->GetPlatformPrintJob æT Class Method æD ODPlatformPrintJob GetPlatformPrintJob( ODGraphicsSystem g ); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation This method is very similar to GetPlatformCanvas; it returns the graphics-system-dependent print job data associated with a particular graphics system. (If there is none, an exception is raised.) This call makes sense only for a static printing canvas. Inputs g The graphics system of interest Outputs <return> The platform print job (cast to type ODPlatformCanvas) if it exists. Exceptions Signalled kODErrInvalidGraphicsSystem The graphics system is unknown; or there is no print job associated with it. Pre conditions None. Post conditions None. æKY ODCanvas::GetUpdateShape Canvas::GetUpdateShape Canvas->GetUpdateShape æT Class Method æD ODShape* GetUpdateShape(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the shape describing the area of this canvas which needs to be redrawn. The caller must release this shape when done with it. Inputs None. Outputs <return> The update shape of this canvas. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODCanvas::HasPlatformCanvas Canvas::HasPlatformCanvas Canvas->HasPlatformCanvas æT Class Method æD ODBoolean HasPlatformCanvas( ODGraphicsSystem ); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns true if a platform canvas is associated with this graphics system in this canvas. Inputs g The graphics system to query Outputs <return> kODTrue if a platform canvas exists for this graphics system; else kODFalse. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODCanvas::HasPlatformPrintJob Canvas::HasPlatformPrintJob Canvas->HasPlatformPrintJob æT Class Method æD ODBoolean HasPlatformPrintJob( ODGraphicsSystem g ); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation This method is very similar to HasPlatformCanvas; it returns true if the canvas has a platform print job associated with the particular graphics system. This call makes sense only for a static printing canvas. Inputs g The graphics system of interest Outputs <return> kODTrue if there is a platform print job for this graphics system; else kODFalse. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODCanvas::InitCanvas Canvas::InitCanvas Canvas->InitCanvas æT Class Method æD void InitCanvas( ODGraphicsSystem graphicsSystem, ODPlatformCanvas platformCanvas, ODBoolean isDynamic, ODBoolean isOffscreen); æC Protection Public. Should only be called by factory methods. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Initialize a newly constructed canvas so it can be used. Assign parameters to fields, and allocate internal data structures. Inputs graphicsSystem The code for the canvas' graphics system. Platform-specific. platformCanvas The platform-specific canvas data structure.Will NOT be disposed during destruction of this object. isDynamic kODTrue if canvas is dynamic, kODFalse if static. isOffscreen kODTrue if canvas is offscreen, kODFalse otherwise. Outputs None. Exceptions Signalled None. Pre conditions Canvas was just constructed. Post conditions Canvas can be used for imaging. æKY ODCanvas::Invalidate Canvas::Invalidate Canvas->Invalidate æT Class Method æD void Invalidate( ODShape* shape); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Add "shape" to the update shape of this canvas. Also invalidates the corresponding shape on the parent canvas, if any. Inputs shape The area to add to the update shape. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODCanvas::IsDynamic Canvas::IsDynamic Canvas->IsDynamic æT Class Method æD ODBoolean IsDynamic(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, before derived class behavior. Basic operation Returns true if this is a dynamic canvas, false if it is static. Inputs None. Outputs <return> kODTrue if this canvas is dynamic, kODFalse if static. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODCanvas::IsOffscreen Canvas::IsOffscreen Canvas->IsOffscreen æT Class Method æD ODBoolean IsOffscreen(); æC Protection Public. No restrictions. Override policy Derived class can override. Derived class can call base class behavior, before derived class behavior. Basic operation Returns whether this canvas is offscreen. Inputs None. Outputs <return> kODTrue if this canvas is offscreen, kODFalse otherwise. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODCanvas::Purge Canvas::Purge Canvas->Purge æT Class Method æD ODSize Purge( ODSize size); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Attempt to free up to "size" bytes of memory by releasing any unneeded internal storage. Inputs size The number of bytes to attempt to free. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODCanvas::ResetUpdateShape Canvas::ResetUpdateShape Canvas->ResetUpdateShape æT Class Method æD void ResetUpdateShape(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Set the update shape to be the empty shape. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODCanvas::SetBiasTransform Canvas::SetBiasTransform Canvas->SetBiasTransform æT Class Method æD void SetBiasTransform( ODTransform *x ); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Attaches a transformation (the "bias transform") to the canvas; it will be concatenated in between the canvas' owning frame's transform (if any) and the canvas' root frame's transform. The usual purpose of this is to add a vertical flip and offset as glue between frames whose graphics systems' coordinate systems have different handedness, e.g. native and Windows-based frames on an OS/2 system. This call increments the transform's reference-count. Inputs x The transform to use as the bias. It is adopted by the canvas; the caller must not use, modify or delete it thereafter. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions Any preexisting bias transform will be deleted. The new transform passed in will be adopted by the canvas. æKY ODCanvas::SetFacet Canvas::SetFacet Canvas->SetFacet æT Class Method æD void SetFacet( ODFacet* facet); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Set the facet field of this canvas. This should be done by the facet when the canvas is added to it. Inputs facet The facet for the canvas. Outputs None. Exceptions Signalled None. Pre conditions This canvas should be the canvas for "facet". Post conditions None. æKY ODCanvas::SetOwner Canvas::SetOwner Canvas->SetOwner æT Class Method æD void SetOwner( ODPart* owner); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Set the pwner part of this canvas. The owner is responsible for copying this canvas' image to its parent canvas. This call increments the owner's reference-count. Inputs owner The new owner part. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODCanvas::SetPlatformCanvas Canvas::SetPlatformCanvas Canvas->SetPlatformCanvas æT Class Method æD void SetPlatformCanvas( ODGraphicsSystem, ODPlatformCanvas ); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Associates a particular platform canvas with a particular graphics system. (The actual type of the platformCanvas depends on the graphics system.) Which graphics systems are supported is implementation dependent; e.g. the Mac supports both QuickDraw and QuickDraw GX. Some implementations allow platform canvases to be set for two or more graphics systems simultaneously; in general, a canvas should be able to store a platformCanvas for any graphics system that a part might use. To remove the association of a platform canvas with a graphics system, pass kODNULL for the platformCanvas. Inputs ODGraphicsSystem The graphics system to associate the platformCanvas with. ODPlatformCanvas The platform canvas data, cast to type ODPlatformCanvas (a void*); or kODNULL for no platform canvas. Outputs None. Exceptions Signalled kODErrInvalidGraphicsSystem The graphics system is unknown. Pre conditions None. Post conditions None. æKY ODCanvas::SetPlatformPrintJob Canvas::SetPlatformPrintJob Canvas->SetPlatformPrintJob æT Class Method æD void SetPlatformPrintJob( ODGraphicsSystem g, ODPlatformPrintJob j ); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation This method is very similar to SetPlatformCanvas; it sets the graphics-system-dependent print job data associated with a particular graphics system. This call makes sense only for a static printing canvas. Inputs g The graphics system of interest. j The platform print job, cast to type ODPlatformCanvas, or NULL to clear the print job data. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODCanvas::somInit Canvas::somInit Canvas->somInit æT Class Method æD somInit(); æC Protection Public. Canvases should only be directly created by factory methods. Override policy Derived class must override. Derived class must call base class behavior, before derived class behavior. Basic operation Class constructor Inputs None. Outputs <return> an ODCanvas object. Exceptions Signalled kODErrInvalidPlatformCanvas kODOutOfMemory cannot allocate ODCanvas object. Pre conditions None. Post conditions None. æKY ODCanvas::somUninit Canvas::somUninit Canvas->somUninit æT Class Method æD somUninit(); æC Protection Public. No restrictions. Override policy Derived class must override. Derived class must call base class behavior, after derived class behavior. Basic operation Class destructor. Delete internal data structures. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODCanvas::Validate Canvas::Validate Canvas->Validate æT Class Method æD void Validate( ODShape* shape); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Subtract "shape" from this canvas' update shape. Inputs shape The area to subtract from the update shape. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODClipboardHelp ODClipboard Clipboard æKL ODClipboard::ODClipboard ODClipboard::~ODClipboard ODClipboard::ActionDone ODClipboard::ActionRedone ODClipboard::ActionUndone ODClipboard::Clear ODClipboard::DraftClosing ODClipboard::ExportClipboard ODClipboard::GetContentStorageUnit ODClipboard::GetUpdateID ODClipboard::InitClipboard ODClipboard::Purge ODClipboard::SetPlatformClipboard ODClipboard::ShowPasteAsDialog ODClipboard::fSU æC Basic Class Documentation ODClipboard provides a clipboard-like data transfer service between OpenDoc documents (and parts), and between a OpenDoc document and a non-OpenDoc document. Platform vendor should implement this class. This class is not derived from any class. However, it depends on the system service which provides data transfer within a process and between processes. (For simplicity, this data transfer service will be called system clipboard in this document.) Theory of Operation At the process' startup time, a ODClipboard object is instantiated and stored with the ODSession. Whenever a part needs the clipboard service, it can acquire the ODClipboard object through the ODSession object. The main client for this class is ODPart. To ensure thread-safe access to the clipboard, parts should acquire the clipboard focus before getting the content storage unit from the clipboard object. An active part should acquire the clipboard focus before enabling items on the edit menu. An active part holding the clipboard focus should be prepared to relinquish the clipboard focus to allow background parts to inspect the clipboard. Whenever data transfer is required (e.g., a part responding to a menu event corresponding to Copy), the part should get the ODClipboard object from ODSession, get the clipboard storage unit by calling the GetContentStorageUnit method of the ODClipboard object, and read data from or write data to the storage unit. Invariants Maintained by Class The ODStorageUnit object must be created using ODDraft object. Both member fields should be valid from the construction to the destruction of the class. (Note that the client of this class should never cache the ODClipboard object nor its ODStorageUnit. Instead, it should get these objects from ODSystemInterface and ODClipboard APIs whenever they are needed.) The ODStorageUnit returned is guaranteed to contain the content of the system clipboard. æKY ODClipboard::ODClipboard Clipboard::ODClipboard Clipboard->ODClipboard æT Class Method æD ODClipboard(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation This function is the constructor of the ODClipboard object. It is called once at the process' startup time. It initializes the system clipboard. Inputs None Outputs None Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODClipboard::~ODClipboard Clipboard::~ODClipboard Clipboard->~ODClipboard æT Class Method æD ~ODClipboard(); æC Protection Public. None. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation This function is the destructor of the ODClipboard object. It is called once when the process quits. It should close the system service that the constructor has initialized. Inputs None Outputs None Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODClipboard::ActionDone Clipboard::ActionDone Clipboard->ActionDone æT Class Method æD ODUpdateID ActionDone( ODCloneKind cloneKind); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Informs the clipboard object that an action has been performed involving the clipboard. The client must remember the returned ODUpdateID for use in later calls to ActionUndone or ActionRedone. Note that the ODUpdateID value returned is used just to identify a particular clipboard generation. When pasting from the clipboard, be sure to generate a new change ID for the purposes of notifying affected link sources and containing parts. Inputs cloneKind The ODCloneKind value used to clone to or from the clipboard. The valid values are kODCloneCut, kODCloneCopy, and kODClonePaste. Outputs <return> The ODUpdateID value associated with the clipboard contents involved with this operation. Exceptions Signalled kODErrIllegalClipboardCloneKind The cloneKind argument is not kODCloneCopy, kODCloneCut, or kODClone paste. Pre conditions None. Post conditions None. æKY ODClipboard::ActionRedone Clipboard::ActionRedone Clipboard->ActionRedone æT Class Method æD void ActionRedone( ODUpdateID update, ODCloneKind cloneKind); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Notifies the clipboard object that an operation involving the clipboard has been redone. The update argument identifies the clipboard generation at the time of the original operation (returned by ActionDone), and the cloneKind is that of the original action. Inputs update The kODUpdateID value returned by ActionDone at the time of the original operation. cloneKind The cloneKind of the original operation. Outputs None. Exceptions Signalled kODErrIllegalClipboardCloneKind The cloneKind argument is not kODCloneCopy, kODCloneCut, or kODClone paste. Pre conditions None. Post conditions None. æKY ODClipboard::ActionUndone Clipboard::ActionUndone Clipboard->ActionUndone æT Class Method æD void ActionUndone( ODUpdateID update, ODCloneKind cloneKind); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Notifies the clipboard object that an operation involving the clipboard has been undone. The update argument identifies the clipboard generation at the time of the original operation (returned by ActionDone), and the cloneKind is that of the original action. Inputs update The kODUpdateID value returned by ActionDone at the time of the original operation. cloneKind The cloneKind of the original operation. Outputs None. Exceptions Signalled kODErrIllegalClipboardCloneKind The cloneKind argument is not kODCloneCopy, kODCloneCut, or kODClone paste. Pre conditions None. Post conditions None. æKY ODClipboard::Clear Clipboard::Clear Clipboard->Clear æT Class Method æD void Clear(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation This function removes all the user data stored in the ODClipboard object and clears the system clipboard. The client must not be holding a storage unit reference returned by a prior call to GetContentStorageUnit. Inputs None. Outputs None. Exceptions Signalled <platform errors> Host platform errors. Pre conditions This clipboard object has been initialized. Post conditions The next call to GetContentStorageUnit returns an ODStorageUnit with no properties. æKY ODClipboard::DraftClosing Clipboard::DraftClosing Clipboard->DraftClosing æT Class Method æD void DraftClosing( ODDraft* draft); æC Protection Public. Called only by container applications. Parts may not call. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Notifies the clipboard object that a document draft is closing. If a part in the closing draft has written promises to the clipboard, the clipboard should ensure those promises are resolved. If a part in the closing draft has cut data to the clipboard, the clipboard should now treat that data as if it had been copied to the clipboard (cut semantics no longer apply). Inputs draft The document draft that is about to close. Outputs None. Exceptions Signalled kODErrOutOfMemory Out of memory. <platform errors> Host platform errors. Pre conditions The argument is a valid draft object. Post conditions The clipboard contains no promises from the argument draft. æKY ODClipboard::ExportClipboard Clipboard::ExportClipboard Clipboard->ExportClipboard æT Class Method æD void ExportClipboard(); æC Protection Protected. This method is for internal use by platform implementations of OpenDoc. It should not be called by parts. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation If this clipboard has been changed since the last change to the host platform clipboard, update the host clipboard now. This methods should be called by the Container Application whenever the current content of the OpenDoc clipboard must be transferred to the platform clipboard. On the Macintosh, this includes when the application is suspended or quit. Inputs None. Outputs None. Exceptions Signalled kODErrOutOfMemory Out of Memory <platform errors> Host platform errors. Pre conditions None. Post conditions The host platform clipboard contains the most recently cut or copied items. æKY ODClipboard::GetContentStorageUnit Clipboard::GetContentStorageUnit Clipboard->GetContentStorageUnit æT Class Method æD ODStorageUnit* GetContentStorageUnit(); æC Protection Public. The returned ODStorageUnit object should not be cached by the caller. Also, the ODClipboard object handles the creation and destruction of the ODStorageUnit. Therefore, the caller should neither dispose or release the returned object. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation This function returns a ODStorageUnit object. The initial content of the ODStorageUnit comes from the system clipboard. The caller can read data from or write data to the ODStorageUnit. The caller must not release the returned ODStorageUnit. Inputs None. Outputs <return> An ODStorageUnit containing the content of the clipboard. This object should not be released. Exceptions Signalled <platform errors> Host platform errors. Pre conditions This clipboard object has been initialized. Post conditions The returned ODStorageUnit contains the content of the system clipboard. æKY ODClipboard::GetUpdateID Clipboard::GetUpdateID Clipboard->GetUpdateID æT Class Method æD ODUpdateID GetUpdateID(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns the update id identifying the clipboard content. ODUpdateID values should be tested for equality only. GetUpdateID may be called without acquiring the clipboard lock (but then there is no guarantee the clipboard won't change before the next clipboard operation). ODUpdateID values returned by this method are only valid during the current session. Inputs None. Outputs <return> the update identification of the current clipboard content. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODClipboard::InitClipboard Clipboard::InitClipboard Clipboard->InitClipboard æT Class Method æD void InitClipboard( ODSession* session); æC Protection Protected. Override policy Derived class cannot override. Derived class must call base class behavior, before derived class behavior. Basic operation Initialize this clipboard object. Inputs session Access to globals. Outputs None. Exceptions Signalled None. Pre conditions This is a valid ODClipboard object. Post conditions This is an initialized ODClipboard object. æKY ODClipboard::Purge Clipboard::Purge Clipboard->Purge æT Class Method æD ODSize Purge( ODSize size); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Attempts to free any storage it can. Returns amount it was able to free. Inputs size Amount of memory requested Outputs Return value Amount of memory that was freed Exceptions Signalled None. Pre conditions None. Post conditions Some memory may be freed for use. æKY ODClipboard::SetPlatformClipboard Clipboard::SetPlatformClipboard Clipboard->SetPlatformClipboard æT Class Method æD void SetPlatformClipboard( ODPlatformTypeList* typeList ); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation If this OpenDoc clipboard has changed since the last change to the host platform clipboard, put data on the host clipboard. The data transferred is specified by the typeList argument, which is a list of platform-dependent types. Data is placed on the platform clipboard in the same order as its corresponding ISO data on this clipboard. To keep host clipboard behavior consistent, translation to the argument type is not attempted. If the typeList argument is a nil object pointer, all content values are copied to the platform clipboard; no embedded parts on the clipboard are copied. This routine should be called prior to using a platform-specific service that uses the host clipboard. Inputs typeList The list of platform types to deposit on the host clipboard, if present on this clipboard. Outputs None. Exceptions Signalled kODErrOutOfMemory Out of Memory Pre conditions This clipboard object has been initialized. Post conditions Any of the agrument platform types from the last cut or copy operation are present on the host clipboard. æKY ODClipboard::ShowPasteAsDialog Clipboard::ShowPasteAsDialog Clipboard->ShowPasteAsDialog æT Class Method æD ODBoolean ShowPasteAsDialog( ODBoolean canPasteLink, ODPasteAsMergeSetting mergeSetting, ODFacet* facet, ODTypeToken viewType, ODPasteAsResult* result); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation This function shows the Paste As Dialog and sets the appropriate dialog items according to the input parameters. If the function returns kODFalse, that means the user cancels out of the dialog. Otherwise, the output parameter result shows what kind of action the client of ShowPasteAsDialog should perform. Inputs canPasteLink boolean showing a link can be pasted. mergeSetting specifies if merging and/or embedding is supported, and determines the initial setting. facet Facet from which the Paste As Dialog is triggered. viewType View Type of the transfered data Outputs <return> boolean showing whether the user clicks OK. result Result reflecting the user 's choice. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODClipboard::fSU Clipboard::fSU æT Class Field æD ODStorageUnit* æC æKY ODConstantsHelp ODConstants Constants æKL Bento Container Suite Private Link Type Constants Constants Binding Constants Constants Category Constants Constants Data Interchange Constants Data Interchange - Persistent Properties Constants Data Interchange - Persistent Value Types Constants Error Codes Constants Error Codes2 Constants Error Codes - General Constants General Constants Layout Constants Messaging - Properties for Part Info Dialog Constants Messaging subsystem Constants Name Spaces Constants ODPart - Persistent Properties Constants Standard Persistent Types Constants Standard Persistent Properties Constants Storage Subsystem - Errors Constants Storage System Constants UI Subsystem - Standard Mac Events Constants UI Subsystem - Additional OpenDoc Events Constants UI Subsystem - Command IDs Constants UI Subsystem - Foci Constants UI Subsystem - Menu IDs Constants UI Subsystem - Part Codes Constants UI Subsystem-Persistent Properties Constants UI subsytem - Undo Constants æKY Bento Container Suite Private Link Type Constants Constants æKL kODLinkContent kODLinkSource kODLink æKY kODLinkContent æC The ODType value used to identify a link content storage unit; used as the value of the kODPropStorageUnitType property. æKY kODLinkSource æC An ODType value. The value of the kODPropStorageUnitType property of storage units containing the persistent form of an ODLinkSource object. æKY kODLink æC An ODType value. The value of the kODPropStorageUnitType property of storage units containing the persistent form of an ODLink object. æKY Binding Constants Constants æKL kODContainerSuite kODKind kODEditorKinds kODViewer kODKindOldMacOSType kODEditorPlatformKind kODEditorHelpFile kODEditorUserString kODKindUserString kODCategoryUserString kODSimpleViewer kODPlatformFileType kODPlatformDataType kODSysPrefContainerSuites kODSysPrefEditorKinds kODSysPrefEditorCategories kODBlackBoxHandlerOfLastResort kODNoEditor kODNameMappings kODIsMacOSTypeID kODIsINTLTextID kODIsAnISOStringID kODIsAnISOStringListID kODIsPltfmTypeSpacID æKY kODContainerSuite æC An ODISOString. The identifier for the ContainerSuite 'nmap' resource. æKY kODKind æC An ODISOString. The identifier for the KindCategories 'nmap' resource. æKY kODEditorKinds æC An ODISOString. The identifier for the EditorKind 'nmap' resource. æKY kODViewer æC An ODISOString. The identifier for the Viewer 'nmap' resource. æKY kODKindOldMacOSType æC An ODISOString. The identifier for the KindOldMacOSType 'nmap' resource. æKY kODEditorPlatformKind æC An ODISOString. The identifier for the EditorPlatformKind 'nmap' resource. æKY kODEditorHelpFile æC An ODISOString. The identifier for the EditorHelpFile 'nmap' resource. æKY kODEditorUserString æC An ODISOString. The identifier for the EditorUserString 'nmap' resource. æKY kODKindUserString æC An ODISOString. The identifier for theKindUserString 'nmap' resource. æKY kODCategoryUserString æC An ODISOString. The identifier for the CategoryUserString 'nmap' resource. æKY kODSimpleViewer æC The identifier for the Simple Viewer Type used in the Viewer 'nmap' resource. æKY kODPlatformFileType æC The identifier for the Platform File Type used in the PlatformKinds 'nmap' resource. æKY kODPlatformDataType æC The identifier for the Platform Data Type used in the PlatformKinds 'nmap' resource. æKY kODSysPrefContainerSuites æC An ODISOString. The identifier for the SysPrefContainerSuites name space owned by Binding. æKY kODSysPrefEditorKinds æC An ODISOString. The identifier for the SysPrefEditorKinds name space owned by Binding. æKY kODSysPrefEditorCategories æC An ODISOString. The identifier for the SysPrefEditorCateogories name space owned by Binding. æKY kODBlackBoxHandlerOfLastResort æC An ODISOString. The ISOString for NoPart "Apple::NoPart". æKY kODNoEditor æC A null ODEditor. æKY kODNameMappings æC The resource type for 'nmap' resources. æKY kODIsMacOSTypeID æC The Mac OSType 'nmap' resource type. æKY kODIsINTLTextID æC The International Text type 'nmap' resource type. æKY kODIsAnISOStringID æC The ISO String 'nmap' resource type. æKY kODIsAnISOStringListID æC The ISO String list 'nmap' resource type. æKY kODIsPltfmTypeSpacID æC The Platform Type Space 'nmap' resource type. æKY Category Constants Constants æKL kODCategoryPlainText kODCategoryStyledText kODCategoryDrawing kODCategory3DGraphic kODCategoryPainting kODCategoryMovie kODCategorySampledSound kODCategoryStructuredSound kODCategoryChart kODCategoryFormula kODCategorySpreadsheet kODCategoryTable kODCategoryDatabase kODCategoryQuery kODCategoryConnection kODCategoryScript kODCategoryOutline kODCategoryPageLayout kODCategoryPresentation kODCategoryCalendar kODCategoryForm kODCategoryExecutable kODCategoryCompressed kODCategoryControlPanel kODCategoryControl kODCategoryPersonalInfo kODCategorySpace kODCategoryProject kODCategorySignature kODCategoryKey kODCategoryUtility kODCategoryMailingLabel kODCategoryLocator kODCategoryPrinter kODCategoryTime æC Part Kind Categories. Your kinds almost certainly fall into one or more of these categories. Please hesitate before creating a new category, the OpenDoc Human Interface folks have worked very hard to make sure that most (>90%) of document kinds already out there fit into one of these categories. æKY kODCategoryPlainText æC The category of a Plain Text part kind such as ASCII or Apple Standard Roman. æKY kODCategoryStyledText æC The category of a Styled Text part kind such as 'styl' or MacWrite II format. æKY kODCategoryDrawing æC The category of a Drawing part kind such as 'PICT' or MacDraw format. æKY kODCategory3DGraphic æC The category of a 3D Graphic part kind such as QuickTimeVR format. æKY kODCategoryPainting æC The category of a Painting part kind such as TIFF or MacPaint format. æKY kODCategoryMovie æC The category of a Movie part kind such as QuickTime format. æKY kODCategorySampledSound æC The category of a Sampled Sound part kind such as 'snd ' format. æKY kODCategoryStructuredSound æC The category of a Structured Sound part kind such as MIDI format. æKY kODCategoryChart æC The category of a Chart part kind. æKY kODCategoryFormula æC The category of a Formula part kind such as an equation editor format. æKY kODCategorySpreadsheet æC The category of a Spreadsheet part kind such as SYLK or Resolve format. æKY kODCategoryTable æC The category of a Table part kind such as a tab delimited text format. æKY kODCategoryDatabase æC The category of a Database part kind such as FileMaker format. æKY kODCategoryQuery æC The category of a Query part kind such as SQL format. æKY kODCategoryConnection æC The category of a Connection part kind such as CommToolBox Connection Tool preferences format. æKY kODCategoryScript æC The category of a Script part kind such as HyperTalk, MPW Script, AppleScript, or any other OSA compliant scripting language format. æKY kODCategoryOutline æC The category of a Outline part kind. æKY kODCategoryPageLayout æC The category of a Page Layout part kind. æKY kODCategoryPresentation æC The category of a Presentation part kind. æKY kODCategoryCalendar æC The category of a Calendar part kind. æKY kODCategoryForm æC The category of a Form part kind. æKY kODCategoryExecutable æC The category of a Executable part kind such as .COM, .EXE and other executables. æKY kODCategoryCompressed æC The category of a Compressed part kind such as sit or pit or cpt. æKY kODCategoryControlPanel æC The category of a Control Panel part kind such as Editor Setup. æKY kODCategoryControl æC The category of a Control part kind such as a button kind. æKY kODCategoryPersonalInfo æC The category of a Personal Info part kind such as a business card. æKY kODCategorySpace æC The category of a Space part kind such as a folder, hard disk, server or room. æKY kODCategoryProject æC The category of a Project part kind such as MacProject. æKY kODCategorySignature æC The category of a Signature part kind such as a PowerTalk signature. æKY kODCategoryKey æC The category of a Key part kind such as any password, AppleShare, login, PGP etc. æKY kODCategoryUtility æC The category of a Utility part kind. æKY kODCategoryMailingLabel æC The category of a Mailing Label part kind such as a PowerTalk mailer. æKY kODCategoryLocator æC The category of a Locator part kind such as a URL. æKY kODCategoryPrinter æC The category of a Printer part kind. æKY kODCategoryTime æC The category of a Time part kind. This category is here for the infamous clock parts. Where else would they fit? æKY Data Interchange Constants æKL kODUnknownChange kODCloneCopy kODCloneCut kODDropFail kODInLinkDestination kODInLinkSource kODPasteAsMerge kODDropUnfinished kODCloneDropCopy kODCloneDropMove kODDropCopy kODDropMove kODNoWait kODCloneToLink kODCloneFromLink kODPropProxyContent kODPropContentIsFrame kODDragIsInSourceFrame kODDragIsInSourcePart kODDropIsInSourceFrame kODDropIsInSourcePart kODDropIsMove kODDropIsCopy kODDropIsPasteAs kODPasteAsMerge kODPasteAsEmbed kODPasteAsMergeOnly kODPasteAsEmbedOnly æC These constants are used during data interchange. æKY kODUnknownChange æC An ODChangeID value guaranteed to be different than any actual change identification. Can be used by parts when the change identifcation associated with shared content is unknown. æKY kODCloneCopy æC An ODCloneKind value specifying copy semantics into an intermediate draft such as the clipboard or a drag-and-drop container. æKY kODCloneCut æC An ODCloneKind value specifying cut semantics into an intermediate draft. æKY kODDropFail æC An ODDropResult value signifying an unsuccessful synchronous drop. æKY kODInLinkDestination æC The ODLinkStatus value signifying a frame embedded in the destination of a link; the content of this frame is thus supplied by a link. æKY kODInLinkSource æC The ODLinkStatus value signifying a frame that is embedded in one or more sources of a link, but not in content that is the destination of a link. æKY kODPasteAsMerge æC An ODPasteAsMergeSetting value that enables merge and embed, with merge the initial setting. æKY kODDropUnfinished æC An ODDropResult value signifying an asynchronous drag was started. æKY kODCloneDropCopy æC An ODCloneKind value specifying copy semantics at the destination of a drop and used instead of kODClonePaste. æKY kODCloneDropMove æC An ODCloneKind value specifying move semantics at the destination of a drop and used instead of kODClonePaste. æKY kODDropCopy æC An ODDropResult value signifying a successful synchronous drop with copy semantics. æKY kODDropMove æC An ODDropResult value signifying a successful synchronous drop with move semantics. æKY kODNoWait æC An ODULong value specifying not to wait to acquire a busy lock on the clipboard or on a link. æKY kODCloneToLink æC An ODCloneKind value indicating cloning to a link. æKY kODCloneFromLink æC An ODCloneKind value indicating cloning from a link æKY kODPropProxyContent æC A part may write this property to the root storage unit of the clipboard, a drag and drop container, or a link, to associate intrinsic data with the embedded frame written to the kODPropContents property. æKY kODPropContentIsFrame æC The presense of this property in the root storage unit of the clipboard , a drag and drop container, or a link, indicates that the kODPropContents property originated from a single embedded frame. æKY kODDragIsInSourceFrame æC Drag Attribute showing that the Drag has left the source frame. This constant should only be used in ODPart::DragEnter and ODPart::DragWithin. æKY kODDragIsInSourcePart æC Drag Attribute to show that the drag is still in the source part. This constant should only be used in ODPart::DragEnter and ODPart::DragWithin. æKY kODDropIsInSourceFrame æC Drag Attribute showing that a drop happens in the source frame. This constant should only be used during ODPart::Drop. æKY kODDropIsInSourcePart æC Drag Attribute showing that a drop happens in the source part. This constant should only be used during ODPart::Drop. æKY kODDropIsMove æC Drag Attribute showing that a drop should be a move. This constant should only be used during ODPart::Drop. æKY kODDropIsCopy æC Drag Attribute showing that a drop should be a copy. This constant should only be used during ODPart::Drop. æKY kODDropIsPasteAs æC Drag Attribute showing that a drop should be treated as a "paste as". This constant should only be used during ODPart::Drop. æKY kODPasteAsMerge æC An ODPasteAsMergeSetting value that enables merge and embed, with merge the initial setting. æKY kODPasteAsEmbed æC An ODPasteAsMergeSetting value that enables merge and embed, with embed the initial setting. æKY kODPasteAsMergeOnly æC An ODPasteAsMergeSetting value that does not allow embedding. æKY kODPasteAsEmbedOnly æC An ODPasteAsMergeSetting value that does not allow merging. æKY Data Interchange - Persistent Properties Constants æKL kODPropLink kODPropLinkSource kODPropLinkSpec kODPropEditionAlias kODPropLinkSection kODPropLinkContentSU kODPropAutoExport kODPropChangeID kODPropOriginalID kODPropOriginalDraft kODPropOriginalCloneKind kODPropEditionID kODPropSectionID kODPropReservedSectionIDs kODPropChangeTime kODPropChangeLimit kODPropObjectType æC These constants identify persistent properties of Data Interchange objects. æKY kODPropLink æC A property containing the persistent identity of an ODLink object. æKY kODPropLinkSource æC A property containing the persistent identity of an ODLinkSource object. æKY kODPropLinkSpec æC A property containing the representation of an ODLinkSpec object. æKY kODPropEditionAlias æC A Macintosh-specific property containing the alias of an edition file used in implementing cross-document links. æKY kODPropLinkSection æC A Macintosh-specific property containing the section record of a cross-document link. æKY kODPropLinkContentSU æC A property containing the persistent identity of an ODStorageUnit serving to store the contents of a link. æKY kODPropAutoExport æC A property containing an ODBoolean value for the auto export status of an ODLinkSource object. æKY kODPropChangeID æC A property containing the persistent form of an ODChangeID value. æKY kODPropOriginalID æC A property of ODLink and ODLinkSource objects in intermediate containers, such as the clipboard, containing the non-persistent object ID of the original object in the original draft. æKY kODPropOriginalDraft æC A draft property of intermediate drafts, such as the clipboard draft, containing the non-persistent object ID of the original draft. æKY kODPropOriginalCloneKind æC A draft property of intermediate drafts, such as the clipboard draft, containing the persistent representation of an ODCloneKind value denoting the operation (kODCloneCut or kODCloneCopy) that deposited content in the draft. æKY kODPropEditionID æC A Macintosh-specific document property containing the last edition file ID used by any draft of the document. æKY kODPropSectionID æC A Macintosh-specific document property containing the last section ID used by any draft of the document. æKY kODPropReservedSectionIDs æC A Macintosh-specific document property containing Edition manager section IDs reserved for use by the container application. æKY kODPropChangeTime æC A link source object property containing the date and time the link source was last updated. æKY kODPropChangeLimit æC A link source object property containing a value used internally during link cycle detection. æKY kODPropObjectType æC Type of the object. æKY Data Interchange - Persistent Value Types Constants æKL kODLinkSpec kODAppleTEXT kODApplestyl kODApplePICT kODApplehfs kODApplesnd kODApplealis kODApplesect kODApplestxt kODDragImageRegionHandle kODObjectType æC These constants identify persistent value types used in Data Interchange. æKY kODLinkSpec æC The ODValueType for the persistent form of an ODLinkSpec object. æKY kODAppleTEXT æC The ODValueType for values in Apple 'TEXT' scrap format. æKY kODApplestyl æC The ODValueType for values in Apple 'styl' scrap format. æKY kODApplePICT æC The ODValueType for values in Apple 'PICT' scrap format. æKY kODApplehfs æC The ODValueType for values in Apple 'hfs ' scrap format. æKY kODApplesnd æC The ODValueType for values in Apple 'snd ' scrap format. æKY kODApplealis æC The ODValueType for values in Apple 'alis' scrap format. æKY kODApplesect æC The ODValueType for values in Apple 'sect' scrap format. æKY kODApplestxt æC The ODValueType for values in Apple 'stxt' (styled text) scrap format. æKY kODDragImageRegionHandle æC Image type for StartDrag. æKY kODObjectType æC Type of the object. æKY Error Codes Constants æKL kODErrorOutOfMemory kODErrExistingFocusModule kODErrFocusNotRegistered kODErrInvalidPlatformCanvas kODErrCannotCreateContainer kODErrInvalidDocument kODErrCannotOpenContainer kODErrExistingDispatchModule kODErrInvalidDispatchModule kODErrInvalidDispatchModule kODErrCannotCollapseDrafts kODErrNonEmptyDraft kODErrInvalidBelowDraft kODErrInvalidContainer kODErrInvalidPermissions kODErrInvalidPermissions kODErrNoDocumentProperties kODErrCannotChangePermissions kODInvalidPermissions kODErrOutstandingDraft kODErrOutstandingDraft kODErrCloningInProgress kODInvalidDraft kODErrCannotCreateFrame kODErrCannotCreateLink kODErrCannotCreatePart kODErrNoDraftProperties kODErrCannotGetFrame kODErrCannotGetLink kODErrCannotGetLink kODErrCannotGetPart kODErrInvalidRefCount kODErrInvalidRefCount kODErrInvalidRefCount kODErrInvalidRefCount kODErrInvalidRefCount kODErrInvalidRefCount kODErrInvalidRefCount kODErrInvalidRefCount kODErrInvalidRefCount kODErrInvalidStorageUnit kODErrInvalidStorageUnit kODErrInvalidStorageUnit kODErrInvalidStorageUnit kODErrInvalidStorageUnit kODErrInvalidBase kODInvalidFacet kODErrInvalidPositionCode kODErrInvalidCanvas kODErrInvalidFocusModule kODErrDraftNotSaved <Storage exceptions> <Storage exceptions> <Storage exceptions> <Storage exceptions> kODLinkBroken kODLinkBroken kODErrLinkBroken kODErrLinkBroken kODErrInvalidLinkKey kODErrInvalidLinkKey kODErrInvalidLinkKey kODErrInvalidLinkKey kODErrInvalidLinkKey kODErrInvalidLinkKey kODErrInvalidLinkKey kODErrInvalidLinkKey kODErrInvalidLinkKey kODErrCorruptLinkSpecValue kODErrNoLinkSpecValue kXODErrNotAValidPart kXODErrNotAValidPart kODEResolveError kODEInvalidSemanticEvent kODEInvalidPart kODErrInvalidPart kODErrInvalidPart errAENoSuchObject kODErrKeyAlreadyExists kODOutOfMemory kODOutOfMemory kODOutOfMemory kODOutOfMemory kODOutOfMemory kODErrInvalidExtension kODErrInvalidExtension kODErrInvalidExtension kODErrInvalidKind kODErrNotPrepared kODErrNotPrepared kODErrInvalidLinkData kODErrCantLink kODErrNotDragging kODErrNotDragging kODErrNotDragging kODErrUnknownCanvasType kODErrInvalidFocus kODErrInvalidFocus kODErrInvalidFocus kODErrInvalidFocus kODErrInvalidFocus kODErrInvalidPromise kODErrInvalidFacet kODErrInvalidFacet kODErrInvalidFacet kODErrInvalidFacet kODErrInvalidFacet kODErrInvalidFacet kODErrInvalidFacet kODErrInvalidFacet kODErrInvalidFacet kODErrInvalidFacet kODErrInvalidFacet kODErrCannotEmbed kODErrCannotEmbed kODErrCannotEmbed kODErrCannotEmbed kODErrInvalidLink kODErrInvalidLink kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidUndo kODErrInvalidUndo kODErrInvalidUndo kODErrInvalidUndo kODErrInvalidUndo kODErrZeroRefCount kODErrInvalidGraphicsSystem kODErrInvalidGraphicsSystem kODErrInvalidGraphicsSystem kODErrInvalidGraphicsSystem kODErrInvalidGraphicsSystem kODErrNoShapeGeometry kODErrNoShapeGeometry kODErrNoGeometry kODErrNoGeometry kODErrNoGeometry kODErrNoGeometry kODErrNoGeometry errAEHandlerNotFound errAEHandlerNotFound errAEHandlerNotFound errAEHandlerNotFound errAENotASpecialFunction errAENotASpecialFunction errAENotASpecialFunction kODCannotCreateContainer kODInvalidContainerID kODInvalidContainerID kODCannotGetContainer kODErrCannotAddProperty kODErrValueExists kODErrCloneNotStarted kODErrCloneNotStarted kODErrCloneNotStarted kODErrCloneNotStarted kODErrInvalidDraftKey kODErrInvalidDraftKey kODErrInvalidDraftKey kODErrInvalidDraftKey kODErrInvalidDraftKey kODErrInvalidDraftKey kODErrInvalidValueIndex kODErrInvalidValueIndex kODErrInvalidPropertyName kODErrInvalidPropertyName kODErrInvalidPosCode kODErrInvalidPosCode kODErrInvalidPosCode kODErrInvalidStorageUnitRef kODErrNotPromise kODErrInvalidValue kODErrInvalidValue kODErrUnfocusedStorageUnit. kODUnfocusedStorageUnit kODUnfocusedStorageUnit kODUnfocusedStorageUnit kODUnfocusedStorageUnit kODUnfocusedStorageUnit kODErrStorageUnitLocked kODErrCannotAddType kODErrCannotAddType kODErrCannotAddType kODErrUnfocusedStorageUnit kODErrUnfocusedStorageUnit kODErrUnfocusedStorageUnit kODErrUnfocusedStorageUnit kODErrUnfocusedStorageUnit kODErrUnfocusedStorageUnit kODErrUnfocusedStorageUnit kODErrUnfocusedStorageUnit kODErrUnfocusedStorageUnit kODErrUnfocusedStorageUnit kODErrUnfocusedStorageUnit kODErrUnfocusedStorageUnit kODErrUnfocusedStorageUnit kODErrUnfocusedStorageUnit kODErrInvalidStorageUnitKey kODErrInvalidStorageUnitKey kODErrStorageUnitNotLocked valueIndex valueIndex kODErrInvalidProperty kODErrInvalidProperty kODNotValueFocussed kODNotValueFocussed kODErrNumericError kODErrCannotTranslate kODErrCannotTranslate kODErrBadTranslationMethod kODErrCannotDisposeTranslationMethod kODErrCannotDisposeTranslationMethod kODErrInvalidType kODErrInvalidType kODErrInvalidType kODErrInvalidType kODErrInvalidType kODErrInvalidType kODErrInvalidType kODErrInvalidType kODErrIteratorOutOfSync kODErrIteratorOutOfSync kODErrIteratorOutOfSync kODErrIteratorOutOfSync kODErrCannotAddAction kODErrCannotMarkAction kODErrEmptyStack kODErrEmptyStack kODErrWrongType kODErrWrongType kODErrInvalidName kODErrInvalidName kODErrInvalidName kODErrInvalidName kODErrInvalidName kODErrInvalidWindowState kODErrInvalidWindowState kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrInvalidDraft kODErrInvalidDraft kODErrInvalidDraft kODErrInvalidDraft kODErrInvalidDraft kODErrInvalidDraft kODErrIllegalNullStorageSystemInput kODErrInvalidPersistentObjectID kODErrInvalidObjectType kODErrIllegalClipboardCloneKind æC These are the standard error codes which are returned from the OpenDoc API. æKY kODErrorOutOfMemory æC Out of memory. æKY kODErrExistingFocusModule æC A focus module already exists for that focus. æKY kODErrFocusNotRegistered æC One of the requested foci is not registered. æKY kODErrInvalidPlatformCanvas æC ODCanvas::ODCanvas, æKY kODErrCannotCreateContainer æC ODContainer::Create,Cannot create the physical Container. æKY kODErrInvalidDocument æC ODContainer::GetDocument,Cannot get desired Document because the id is invalid. æKY kODErrCannotOpenContainer æC ODContainer::Open,Cannot open the physical Container. æKY kODErrExistingDispatchModule æC ODDispatcher::AddDispatchModule,module is already installed. æKY kODErrInvalidDispatchModule æC ODDispatcher::AddDispatchModule,specified dispatch module is invalid. æKY kODErrInvalidDispatchModule æC ODDispatcher::AddMonitor,specified dispatch module is invalid. æKY kODErrCannotCollapseDrafts æC ODDocument::CollapseDrafts,from is not above to. æKY kODErrNonEmptyDraft æC ODDocument::CollapseDrafts,Non-empty draft between from and to. æKY kODErrInvalidBelowDraft æC ODDocument::CreateDraft,below is kODNULL or below is not the Top Draft of the Document. æKY kODErrInvalidContainer æC ODDocument::CreateDraft,Container does not support creation of new drafts. æKY kODErrInvalidPermissions æC ODDocument::CreateDraft,Exclusive-Write-Only below is not released. æKY kODErrInvalidPermissions æC ODDocument::GetBaseDraft,Invalid permissions. æKY kODErrNoDocumentProperties æC ODDocument::GetDocumentProperties,Cannot create ODStorageUnit for Document Properties. æKY kODErrCannotChangePermissions æC ODDocument::GetDraft,Cannot change permission on draft if it is gotten again with a different permissions. æKY kODInvalidPermissions æC ODDocument::GetDraft,Invalid permissions. æKY kODErrOutstandingDraft æC ODDocument::CollapseDrafts,There is one or more outstanding Draft (i.e., refCount >= 1) between from and to. æKY kODErrOutstandingDraft æC ODDocument::SaveToAPrevDraft,There is one or more outstanding Draft between from (exclusive) and to (exclusive). æKY kODErrCloningInProgress æC ODDraft::BeginClone,Another Clone has started already. æKY kODInvalidDraft æC ODDraft::ChangedFromPrev,Invalid Draft. æKY kODErrCannotCreateFrame æC ODDraft::CreateFrame,Cannot create ODFrame object. æKY kODErrCannotCreateLink æC ODDraft::CreateLinkSource,Cannot create the ODLinkSource or companion ODLink object. æKY kODErrCannotCreatePart æC ODDraft::CreatePart,Cannot create ODPart object. æKY kODErrNoDraftProperties æC ODDraft::GetDraftProperties,Draft Properties Storage Unit cannot be created. æKY kODErrCannotGetFrame æC ODDraft::GetFrame,Cannot create ODFrame object. æKY kODErrCannotGetLink æC ODDraft::GetLink,Cannot create ODLink object. æKY kODErrCannotGetLink æC ODDraft::GetLinkSource,Cannot create ODLink object. æKY kODErrCannotGetPart æC ODDraft::GetPart,Cannot create ODPart object. æKY kODErrInvalidRefCount æC ODDocument::GetDraft,draft does not have a valid refCount. æKY kODErrInvalidRefCount æC ODDraft::ReleaseFrame,RefCount of object is not 0. æKY kODErrInvalidRefCount æC ODDraft::ReleaseLink,Refcount of link is not 0. æKY kODErrInvalidRefCount æC ODDraft::ReleasePart,RefCount of part is not 0. æKY kODErrInvalidRefCount æC ODDraft::ReleaseStorageUnit,Refcount of storageUnit is not 0. æKY kODErrInvalidRefCount æC ODDraft::RemoveFrame,RefCount of frame is not 1. æKY kODErrInvalidRefCount æC ODDraft::RemoveLink,Refcount of link is not 1. æKY kODErrInvalidRefCount æC ODDraft::RemoveLinkSource,Refcount of link is not 1. æKY kODErrInvalidRefCount æC ODDraft::RemovePart,Refcount of part is not 1. æKY kODErrInvalidStorageUnit æC ODDraft::RemoveFrame,Invalid ODFrame with no ODStorageUnit associated with it. æKY kODErrInvalidStorageUnit æC ODDraft::RemoveLink,Invalid ODLink with no ODStorageUnit associated with it. æKY kODErrInvalidStorageUnit æC ODDraft::RemoveLinkSource,Invalid ODLinkSource with no ODStorageUnit associated with it. æKY kODErrInvalidStorageUnit æC ODDraft::RemovePart,Invalid ODPart with no ODStorageUnit associated with it. æKY kODErrInvalidStorageUnit æC ODDraft::RemoveStorageUnit,Invalid storageUnit. æKY kODErrInvalidBase æC ODExtension::Release,Not a valid base object. æKY kODInvalidFacet æC ODFacet::CreateEmbeddedFacet,"siblingFacet" is not a child of the receiver. æKY kODErrInvalidPositionCode æC ODFacet::CreateEmbeddedFacet,"position" is not a valid position code. æKY kODErrInvalidCanvas æC ODFacet::GetCanvas,Neither this facet or any of its parents had a canvas. æKY kODErrInvalidFocusModule æC ODFocusOwnerIterator::InitFocusOwnerIterator,The specified focus module is invalid. æKY kODErrDraftNotSaved æC ODLinkManager::CreateLink,A link could not be created because the source document has never been saved. æKY <Storage exceptions> æC ODLink::Externalize,Storage exceptions may be signalled. æKY <Storage exceptions> æC ODLink::InitLinkFromStorage,Exceptions may be raised reading persistent properties. æKY <Storage exceptions> æC ODLinkSource::Externalize,Storage exceptions may be signalled. æKY <Storage exceptions> æC ODLinkSource::InitLinkSourceFromStorage,Exceptions may be raised reading persistent properties. æKY kODLinkBroken æC ODLink::InitLinkFromStorage,The associated link source object could not be found. æKY kODLinkBroken æC ODLinkSource::InitLinkSourceFromStorage,The associated link object could not be found. æKY kODErrLinkBroken æC ODLink::ShowSourceContent,Cannot locate the source of the link. æKY kODErrLinkBroken æC ODLinkSource::ShowSourceContent,Cannot locate the source of the link. æKY kODErrInvalidLinkKey æC ODLink::CreateLinkEdition, æKY kODErrInvalidLinkKey æC ODLink::GetContentStorageUnit, æKY kODErrInvalidLinkKey æC ODLink::GetLinkEdition, æKY kODErrInvalidLinkKey æC ODLink::Unlock, æKY kODErrInvalidLinkKey æC ODLink::UpdateLinkEdition, æKY kODErrInvalidLinkKey æC ODLinkSource::GetContentStorageUnit, æKY kODErrInvalidLinkKey æC ODLinkSource::ReadLinkEdition, æKY kODErrInvalidLinkKey æC ODLinkSource::Unlock, æKY kODErrInvalidLinkKey æC ODLinkSource::UseLinkEdition, æKY kODErrCorruptLinkSpecValue æC ODLinkSpec::ReadLinkSpec,Focused property contains an invalid link specification value. æKY kODErrNoLinkSpecValue æC ODLinkSpec::ReadLinkSpec,Focused property does not contain a link specification value. æKY kXODErrNotAValidPart æC ODMessageInterface::CreatePartAddrDesc,ODPart* was not valid. æKY kXODErrNotAValidPart æC ODMessageInterface::CreatePartObjSpec,ODPart* was not valid. æKY kODEResolveError æC ODMessageInterface::ProcessSemanticEvent,Couldn't determine correct object to dispatch to. æKY kODEInvalidSemanticEvent æC ODMessageInterface::Send,Invalid AppleEvent (not created with ODMessageInterface::CreateEvent ). æKY kODEInvalidPart æC ODMessageInterface::Send,Invalid part. æKY kODErrInvalidPart æC ODNameResolver::DisposeToken,Token does not contain a valid part description. æKY kODErrInvalidPart æC ODNameResolver::GetContextInfo,Not a valid part æKY errAENoSuchObject æC ODNameResolver::Resolve,Invalid ODPart* or part does not support the Semantic Interface extension. æKY kODErrKeyAlreadyExists æC ODNameSpaceManager::CreateNameSpace,An ODNameSpace with that name already exists. æKY kODOutOfMemory æC ODCanvas::ODCanvas,cannot allocate ODCanvas object. æKY kODOutOfMemory æC ODMessageInterface::CreateEvent,Couldn't allocate memory for the event. æKY kODOutOfMemory æC ODMessageInterface::InitMessageInterface,Not enough memory for needed storage. æKY kODOutOfMemory æC ODNameResolver::Resolve,Couldn't allocate needed internal structures. æKY kODOutOfMemory æC ODNameSpaceManager::InitNameSpaceManager,Out of memory. æKY kODErrInvalidExtension æC ODExtension::CheckValid,This is an invalid extension and should not be used by any clients. The client should attempt to get the extension from the same base object she got it from before. æKY kODErrInvalidExtension æC ODObject::GetExtension,not an extension that this object knows about æKY kODErrInvalidExtension æC ODObject::ReleaseExtension,not an extension that this object knows about æKY kODErrInvalidKind æC ODPart::ChangeKind,Part does not support that kind of content. æKY kODErrNotPrepared æC ODPart::AbortRelinquishFocus,Part hasn't prepared to relinqush focus. æKY kODErrNotPrepared æC ODPart::CommitRelinquishFocus,Part hasn't prepared to relinqush focus. æKY kODErrInvalidLinkData æC ODPart::CreateLink,Could not identify content for link. æKY kODErrCantLink æC ODPart::CreateLink,Part does not support linking protocol. æKY kODErrNotDragging æC ODPart::DragLeave,Part has not received a DragEnter call. æKY kODErrNotDragging æC ODPart::DragWithin,Part has not received a DragEnter call. æKY kODErrNotDragging æC ODPart::Drop,Part hasn't received a DragEnter message. æKY kODErrUnknownCanvasType æC ODPart::FacetAdded,The part is unable to render itself on the facet's canvas. æKY kODErrInvalidFocus æC ODPart::AbortRelinquishFocus,Part doesn't own this focus. æKY kODErrInvalidFocus æC ODPart::BeginRelinquishFocus,Part doesn't own this focus. æKY kODErrInvalidFocus æC ODPart::CommitRelinquishFocus,Part doesn't own this focus. æKY kODErrInvalidFocus æC ODPart::FocusAcquired,Part cannot own this focus. æKY kODErrInvalidFocus æC ODPart::FocusLost,Part doesn't own this focus. æKY kODErrInvalidPromise æC ODPart::FulfillPromise,The part did not make this promise. æKY kODErrInvalidFacet æC ODFacet::Invalidate,Can't find facet for parent canvas. æKY kODErrInvalidFacet æC ODFacet::MoveBefore,"child" or "sibling" is not a valid child facet of the receiver. æKY kODErrInvalidFacet æC ODFacet::MoveBehind,"child" or "sibling" is not a valid child facet of the receiver. æKY kODErrInvalidFacet æC ODFacet::RemoveFacet,"facet" is not a child of the receiver. æKY kODErrInvalidFacet æC ODPart::FacetRemoved,facet is not a facet of this part. æKY kODErrInvalidFacet æC ODPart::GeometryChanged,facet is not a facet of this part. æKY kODErrInvalidFacet æC ODPart::HandleEvent,facet is not a facet of this part. æKY kODErrInvalidFacet æC ODPart::HighlightChanged,"facet" is not a facet of this part. æKY kODErrInvalidFacet æC ODPart::MouseEnter,facet is not a facet of this part. æKY kODErrInvalidFacet æC ODPart::MouseLeave,facet is not a facet of this part. æKY kODErrInvalidFacet æC ODPart::MouseWithin,facet is not a facet of this part. æKY kODErrCannotEmbed æC ODPart::CreateEmbeddedFramesIterator,This part does not support embedding. æKY kODErrCannotEmbed æC ODPart::GetContainingPartProperties,This part does not support embedding. æKY kODErrCannotEmbed æC ODPart::RemoveEmbeddedFrame,This part does not support embedding. æKY kODErrCannotEmbed æC ODPart::RequestEmbeddedFrame,This part does not support embedding. æKY kODErrInvalidLink æC ODPart::LinkUpdated,This isn't one of my links. æKY kODErrInvalidLink æC ODPart::RevealLink,This isn't one of my links. æKY kODErrInvalidFrame æC ODArbitrator::RelinquishFocus, æKY kODErrInvalidFrame æC ODArbitrator::RelinquishFocusSet, æKY kODErrInvalidFrame æC ODArbitrator::TransferFocus, æKY kODErrInvalidFrame æC ODArbitrator::TransferFocusSet, æKY kODErrInvalidFrame æC ODDispatcher::RegisterIdle,The specified frame is invalid æKY kODErrInvalidFrame æC ODDispatcher::UnregisterIdle,The specified frame is invalid æKY kODErrInvalidFrame æC ODFocusModule::SetFocusOwnership,The specified frame is invalid æKY kODErrInvalidFrame æC ODFocusModule::TransferFocusOwnership,The specified frame is invalid æKY kODErrInvalidFrame æC ODFocusModule::UnsetFocusOwnership,The specified frame is invalid æKY kODErrInvalidFrame æC ODPart::AbortRelinquishFocus,ownerFrame is not a display frame of this part. æKY kODErrInvalidFrame æC ODPart::AdjustBorderShape,embeddedFrame is not an embeddedFrame of this part. æKY kODErrInvalidFrame æC ODPart::AdjustMenus,frame is not a display frame of this part. æKY kODErrInvalidFrame æC ODPart::AttachSourceFrame,Either frame or sourceFrame is not a display frame of this part. æKY kODErrInvalidFrame æC ODPart::BeginRelinquishFocus,ownerFrame is not a display frame of this part. æKY kODErrInvalidFrame æC ODPart::CommitRelinquishFocus,ownerFrame is not a display frame of this part. æKY kODErrInvalidFrame æC ODPart::CreateEmbeddedFramesIterator,frame is not a display frame of this part. æKY kODErrInvalidFrame æC ODPart::DisplayFrameClosed,frame is not a display frame of this part. æKY kODErrInvalidFrame æC ODPart::DisplayFrameConnected,frame is not a display frame of this part. æKY kODErrInvalidFrame æC ODPart::DisplayFrameRemoved,frame is not a display frame of this part. æKY kODErrInvalidFrame æC ODPart::Draw,"frame" isn't one of my display frames. æKY kODErrInvalidFrame æC ODPart::EmbeddedFrameSpec,embeddedFrame is not an embedded frame of this part. æKY kODErrInvalidFrame æC ODPart::FocusAcquired,ownerFrame is not a display frame of this part. æKY kODErrInvalidFrame æC ODPart::FocusLost,ownerFrame is not a display frame of this part. æKY kODErrInvalidFrame æC ODPart::FrameShapeChanged,frame is not a display frame of this part. æKY kODErrInvalidFrame æC ODPart::GetContainingPartProperties,frame is not an embedded frame of this part. æKY kODErrInvalidFrame æC ODPart::GetPrintResolution,frame is not a display frame of this part. æKY kODErrInvalidFrame æC ODPart::HandleEvent,frame is not a display frame of this part. æKY kODErrInvalidFrame æC ODPart::Open,"frame" isn't one of my display frames. æKY kODErrInvalidFrame æC ODPart::PresentationChanged,"frame" isn't one of my display frames. æKY kODErrInvalidFrame æC ODPart::ReadPartInfo,frame is not a display frame of this part. æKY kODErrInvalidFrame æC ODPart::RemoveEmbeddedFrame,frame is not an embedded frame of this part. æKY kODErrInvalidFrame æC ODPart::RevealFrame,frame is not an embedded frame of this part. æKY kODErrInvalidFrame æC ODPart::SequenceChanged,frame is not a display frame of this part. æKY kODErrInvalidFrame æC ODPart::UsedShapeChanged,embeddedFrame is not an embeddedFrame of this part. æKY kODErrInvalidFrame æC ODPart::ViewTypeChanged,frame is not a display frame of this part. æKY kODErrInvalidUndo æC ODPart::DisposeActionState,Not an undo action of this part. æKY kODErrInvalidUndo æC ODPart::ReadActionState,Not an undo action of this part. æKY kODErrInvalidUndo æC ODPart::RedoAction,Not an undo action of this part. æKY kODErrInvalidUndo æC ODPart::UndoAction,Not an undo action of this part. æKY kODErrInvalidUndo æC ODPart::WriteActionState,Not an undo action of this part. æKY kODErrZeroRefCount æC ODRefCntObject::Release,The reference count cannot be decremented because the reference count is already 0. æKY kODErrInvalidGraphicsSystem æC ODCanvas::GetPlatformCanvas,The graphics system is unknown; or there is no platform canvas associated with this graphics system. æKY kODErrInvalidGraphicsSystem æC ODCanvas::GetPlatformPrintJob,The graphics system is unknown; or there is no print job associated with it. æKY kODErrInvalidGraphicsSystem æC ODCanvas::SetPlatformCanvas,The graphics system is unknown. æKY kODErrInvalidGraphicsSystem æC ODShape::GetPlatformShape,Graphics system unknown or not installed. æKY kODErrInvalidGraphicsSystem æC ODShape::SetPlatformShape,not a valid graphics system. æKY kODErrNoShapeGeometry æC ODShape::InverseTransform,Shape does not have enough geometric information to be transformed in this way. æKY kODErrNoShapeGeometry æC ODShape::Subtract,Geometry mode is kODNeedsGeometry, but diffShape has no geometry. æKY kODErrNoGeometry æC ODShape::CopyPolygon,Shape cannot be described as a polygon. æKY kODErrNoGeometry æC ODShape::Intersect,Geometry mode is kODNeedsGeometry, but diffShape has no geometry. æKY kODErrNoGeometry æC ODShape::SetGeometryMode,If mode is set to kODNeedsGeometry but shape has no geometry. æKY kODErrNoGeometry æC ODShape::Transform,Shape doesn't have enough geometric information for this transformation. æKY kODErrNoGeometry æC ODShape::Union,Geometry mode is kODNeedsGeometry, but diffShape has no geometry. æKY errAEHandlerNotFound æC ODSIHelper::GetCoercionHandler,No coercion handler found æKY errAEHandlerNotFound æC ODSIHelper::GetEventHandler,No handler found for an Apple event æKY errAEHandlerNotFound æC ODSIHelper::RemoveCoercionHandler,No coercion handler found æKY errAEHandlerNotFound æC ODSIHelper::RemoveEventHandler,No handler found for an Apple event æKY errAENotASpecialFunction æC ODSIHelper::GetSpecialHandler,Wrong keyword for a special function æKY errAENotASpecialFunction æC ODSIHelper::InstallSpecialHandler,Wrong keyword for a special function æKY errAENotASpecialFunction æC ODSIHelper::RemoveSpecialHandler,Wrong keyword for a special function æKY kODCannotCreateContainer æC ODStorageSystem::CreateContainer,Invalid Container Type. æKY kODInvalidContainerID æC ODStorageSystem::CreateContainer,Invalid Container ID. æKY kODInvalidContainerID æC ODStorageSystem::GetContainer,Invalid Container ID. æKY kODCannotGetContainer æC ODStorageSystem::GetContainer,Invalid Container Type. æKY kODErrCannotAddProperty æC ODStorageUnit::AddProperty,Failure to add the given Property. æKY kODErrValueExists æC ODStorageUnit::AddValue,Value exists alreday. æKY kODErrCloneNotStarted æC ODLink::CloneTo,A Clone was started unsuccessfully. æKY kODErrCloneNotStarted æC ODLinkSource::CloneTo,A Clone was started unsuccessfully. æKY kODErrCloneNotStarted æC ODStorageUnit::CloneInto,A Clone was started unsuccessfully. æKY kODErrCloneNotStarted æC ODStorageUnit::CloneTo,A Clone was started unsuccessfully. æKY kODErrInvalidDraftKey æC ODDraft::AbortClone,Invalid Clone. æKY kODErrInvalidDraftKey æC ODDraft::EndClone, æKY kODErrInvalidDraftKey æC ODLink::CloneTo,Invalid Clone. æKY kODErrInvalidDraftKey æC ODLinkSource::CloneTo,Invalid Clone. æKY kODErrInvalidDraftKey æC ODStorageUnit::CloneInto,Invalid Clone. æKY kODErrInvalidDraftKey æC ODStorageUnit::CloneTo,Invalid Clone. æKY kODErrInvalidValueIndex æC ODStorageUnit::Focus,Invalid value index. æKY kODErrInvalidValueIndex æC ODStorageUnit::Focus,Invalid Value Index. æKY kODErrInvalidPropertyName æC ODStorageUnit::AddProperty,propertyName is kODNULL æKY kODErrInvalidPropertyName æC ODStorageUnit::Focus,No such Property. æKY kODErrInvalidPosCode æC ODDocument::GetDraft,Invalid relative position. æKY kODErrInvalidPosCode æC ODStorageUnit::Focus,Invalid position code. æKY kODErrInvalidPosCode æC ODStorageUnit::Focus,Invalid position code. æKY kODErrInvalidStorageUnitRef æC ODStorageUnit::GetIDFromStorageUnitRef,Invalid Storage Unit Reference. æKY kODErrNotPromise æC ODStorageUnit::GetPromiseValue,The Value does not contain a Promise. æKY kODErrInvalidValue æC ODStorageUnit::GetPromiseValue,Cannot focus to specified Value with valueType. æKY kODErrInvalidValue æC ODStorageUnit::GetType, æKY kODErrUnfocusedStorageUnit. æC ODStorageUnit::GetType, æKY kODUnfocusedStorageUnit æC ODStorageUnit::GetGenerationNumber,This ODStorageUnit object is not focused to a Value. æKY kODUnfocusedStorageUnit æC ODStorageUnit::GetIDFromStorageUnitRef,this ODStorageUnit object is not focused to a Value. æKY kODUnfocusedStorageUnit æC ODStorageUnit::GetSize, æKY kODUnfocusedStorageUnit æC ODStorageUnit::GetStrongStorageUnitRef, æKY kODUnfocusedStorageUnit æC ODStorageUnit::GetWeakStorageUnitRef,this ODStorageUnit is not focused to a Value. æKY kODErrStorageUnitLocked æC ODStorageUnit::Lock,ODStorageUnit is already locked. æKY kODErrCannotAddType æC ODStorageUnit::AddValue,Cannot add Type to Storage Unit. æKY kODErrCannotAddType æC ODStorageUnit::GetPromiseValue,Invalid valueType. æKY kODErrCannotAddType æC ODStorageUnit::SetPromiseValue,Invalid Type. æKY kODErrUnfocusedStorageUnit æC ODStorageUnit::AddValue,This ODStorageUnit is not focused to a Property. æKY kODErrUnfocusedStorageUnit æC ODStorageUnit::CountValues,This ODStorageUnit is not focused to a Property. æKY kODErrUnfocusedStorageUnit æC ODStorageUnit::CreateCursorWithFocus,This ODStorageUnit is not focused to a Property or a Value. æKY kODErrUnfocusedStorageUnit æC ODStorageUnit::DeleteValue,This ODStorageUnit is not focused to a Value. æKY kODErrUnfocusedStorageUnit æC ODStorageUnit::GetOffset,This ODStorageUnit is not focused to a Value. æKY kODErrUnfocusedStorageUnit æC ODStorageUnit::GetPromiseValue,This ODStorageUnit object is not focused to a Property. æKY kODErrUnfocusedStorageUnit æC ODStorageUnit::GetProperty,this ODStorageUnit is not focused to a Property. æKY kODErrUnfocusedStorageUnit æC ODStorageUnit::IncrementGenerationNumber,this ODStorageUnit is not focused to a Value. æKY kODErrUnfocusedStorageUnit æC ODStorageUnit::InsertValue,this ODStorageUnit is not focused to a Value. æKY kODErrUnfocusedStorageUnit æC ODStorageUnit::RemoveStorageUnitRef,this ODStorageUnit is not focused to a Value. æKY kODErrUnfocusedStorageUnit æC ODStorageUnit::SetOffset,this ODStorageUnit is not focused to a Value. æKY kODErrUnfocusedStorageUnit æC ODStorageUnit::SetPromiseValue,this ODStorageUnit is not focused to a Property. æKY kODErrUnfocusedStorageUnit æC ODStorageUnit::SetType,this ODStorageUnit is not focused to a Value. æKY kODErrUnfocusedStorageUnit æC ODStorageUnit::SetValue,this ODStorageUnit is not focused to a Value. æKY kODErrInvalidStorageUnitKey æC ODStorageUnit::Lock,Invalid ODStorageUnitKey. æKY kODErrInvalidStorageUnitKey æC ODStorageUnit::Unlock,Invalid ODStorageUnitKey. æKY kODErrStorageUnitNotLocked æC ODStorageUnit::Unlock,The Storage Unit is not locked. æKY valueIndex æC ODStorageUnitCursor::GetCursor,Value index for the focus context. æKY valueIndex æC ODStorageUnitCursor::GetCursor,Value index for the focus context. æKY kODErrInvalidProperty æC ODStorageUnit::Focus,No such Property. æKY kODErrInvalidProperty æC ODStorageUnitCursor::InitStorageUnitCursor,Property Name is kODNULL. æKY kODNotValueFocussed æC ODStorageUnitView::GetIDFromStorageUnitRef, æKY kODNotValueFocussed æC ODStorageUnitView::GetOffset, æKY kODErrNumericError æC ODTransform::PreCompose, æKY kODErrCannotTranslate æC ODTranslation::Translate,Data cannot be translated using the ODTranslationMethod. æKY kODErrCannotTranslate æC ODTranslation::TranslateView,Data cannot be translated using the ODTranslationMethod. æKY kODErrBadTranslationMethod æC ODTranslation::TranslateView, Corrupted ODTranslationMethod. æKY kODErrCannotDisposeTranslationMethod æC ODTranslation::Translate, TranslationMethod cannot be disposed. æKY kODErrCannotDisposeTranslationMethod æC ODTranslation::TranslateView, TranslationMethod cannot be disposed. æKY kODErrInvalidType æC ODStorageUnit::AddValue,type is kODNULL. æKY kODErrInvalidType æC ODStorageUnit::Exists,Invalid Value Type. æKY kODErrInvalidType æC ODStorageUnit::Focus,No Value with this Type. æKY kODErrInvalidType æC ODStorageUnit::Focus,No Value with such Type. æKY kODErrInvalidType æC ODStorageUnit::GetPromiseValue,valueType is kODNULL. æKY kODErrInvalidType æC ODStorageUnit::SetPromiseValue,valueType is invalid (kODNULL). æKY kODErrInvalidType æC ODStorageUnit::SetType,valueType is invalid (i.e., kODNULL). æKY kODErrInvalidType æC ODTypeList::AddLast,Argument type is not a valid ODType. æKY kODErrIteratorOutOfSync æC ODPlatformTypeListIterator::First,The ODPlatformTypeList instance was changed during the iteration. æKY kODErrIteratorOutOfSync æC ODPlatformTypeListIterator::Next,The ODPlatformTypeList instance was changed during the iteration. æKY kODErrIteratorOutOfSync æC ODTypeListIterator::First,The ODTypeList instance was changed during the iteration. æKY kODErrIteratorOutOfSync æC ODTypeListIterator::Next,The ODTypeList instance was changed during the iteration. æKY kODErrCannotAddAction æC ODUndo::AddActionToHistory,Currently already doing an undo or redo; trying to add a nested begin action. æKY kODErrCannotMarkAction æC ODUndo::MarkActionHistory,ODUndo was never initialized properly. æKY kODErrEmptyStack æC ODUndo::Redo,Redo stack is empty; Undo object was never initialized. æKY kODErrEmptyStack æC ODUndo::Undo,Undo stack is empty; Undo object was never initialized. æKY kODErrWrongType æC ODValueIterator::First,this is thrown if the type of the key does not match the type of the ODNameSpace with which the iterator was initialized. æKY kODErrWrongType æC ODValueIterator::Next,this is thrown if the type of the key does not match the type of the ODNameSpace with which the iterator was initialized. æKY kODErrInvalidName æC ODNameSpace::ReadFromFile,The stored name does not match that of the name space. æKY kODErrInvalidName æC ODNameSpace::ReadFromStorage,The stored name does not match that of the name space. æKY kODErrInvalidName æC ODStorageUnit::Exists,Invalid Property Name. æKY kODErrInvalidName æC ODValueNameSpace::ReadFromFile,The stored name does not match that of the name space. æKY kODErrInvalidName æC ODValueNameSpace::ReadFromStorage,The stored name does not match that of the name space. æKY kODErrInvalidWindowState æC ODDragItemIterator::ODDragItemIterator,The specified window state is not valid. æKY kODErrInvalidWindowState æC ODWindowIterator::InitWindowIterator,The specified window state is not valid. æKY kODErrOutOfMemory æC ODArbitrator::CreateOwnerIterator,Out of memory æKY kODErrOutOfMemory æC ODBinding::InitBinding,Out of memory. æKY kODErrOutOfMemory æC ODClipboard::ExportClipboard,Out of Memory æKY kODErrOutOfMemory æC ODClipboard::SetPlatformClipboard,Out of Memory æKY kODErrOutOfMemory æC ODDispatcher::InitDispatcher,Out of memory æKY kODErrOutOfMemory æC ODFocusSet::Add, æKY kODErrOutOfMemory æC ODFocusSetIterator::First,Not enough memory to allocate the LinkedListIterator æKY kODErrOutOfMemory æC ODLink::InitLink,Out of memory. æKY kODErrOutOfMemory æC ODLink::RegisterDependent,Not enough memory æKY kODErrOutOfMemory æC ODLinkSource::InitLinkSource,Out of memory. æKY kODErrOutOfMemory æC ODMenuBar::AddMenuBefore,Out of memory æKY kODErrOutOfMemory æC ODMenuBar::AddMenuLast,Out of memory æKY kODErrOutOfMemory æC ODMenuBar::AddSubMenu,Out of memory æKY kODErrOutOfMemory æC ODMessageInterface::CreateOSAObject,Not enough memory to create the object. æKY kODErrOutOfMemory æC ODNameResolver::CreateSwapToken,Out of Memory æKY kODErrOutOfMemory æC ODNameSpace::InitNameSpace,Out of memory. æKY kODErrOutOfMemory æC ODNameSpaceManager::CreateNameSpace,Not enough memory æKY kODErrOutOfMemory æC ODObjectNameSpace::InitObjectNameSpace,Out of memory. æKY kODErrOutOfMemory æC ODPart::CreateEmbeddedFramesIterator,Not enough memory to allocate iterator. æKY kODErrOutOfMemory æC ODPart::CreateLink,Not enough memory to allocate link object. æKY kODErrOutOfMemory æC ODPart::ReadActionState,Not enough memory to internalize data. æKY kODErrOutOfMemory æC ODPart::ReadPartInfo,Not enough memory to allocate partInfo. æKY kODErrOutOfMemory æC ODPart::RequestEmbeddedFrame,Not enough memory to embed a part. æKY kODErrOutOfMemory æC ODPlatformTypeList::ODPlatformTypeList,Could not construct this instance. æKY kODErrOutOfMemory æC ODPlatformTypeList::AddLast,Could not add the argument platform type to the list. æKY kODErrOutOfMemory æC ODPlatformTypeList::CreatePlatformTypeListIterator,Could not create the iterator. æKY kODErrOutOfMemory æC ODPlatformTypeList::InitPlatformTypeList,Could not initialize the list. æKY kODErrOutOfMemory æC ODPlatformTypeListIterator::ODPlatformTypeListIterator,Could not construct this instance. æKY kODErrOutOfMemory æC ODSemanticInterface::ForwardEvent,not enough memory to store event in list of forwarded events. æKY kODErrOutOfMemory æC ODSemanticInterface::InitSemanticInterface,Not enough memory to initialize object. æKY kODErrOutOfMemory æC ODSemanticInterface::SetTerminology,Not enough memory to copy list. æKY kODErrOutOfMemory æC ODSession::Tokenize,out of memory æKY kODErrOutOfMemory æC ODShape::Copy, æKY kODErrOutOfMemory æC ODShape::CopyFrom,Not enough memory to copy shape data. æKY kODErrOutOfMemory æC ODShape::CopyPolygon, æKY kODErrOutOfMemory æC ODShape::Intersect,not enough memory to intersect shapes. æKY kODErrOutOfMemory æC ODShape::IsSameAs,not enough memory to compare shapes. æKY kODErrOutOfMemory æC ODShape::NewShape,Not enough memory to create a new shape. æKY kODErrOutOfMemory æC ODShape::Outset,Not enough memory to complete the operation. The shape will be unmodified. æKY kODErrOutOfMemory æC ODShape::Subtract,not enough memory to subtract shapes. æKY kODErrOutOfMemory æC ODSIHelper::InitSIHelper,Not enough room to allocate internal structures. æKY kODErrOutOfMemory æC ODSIHelper::InstallObjectAccessor,out of memory æKY kODErrOutOfMemory æC ODTransform::ODTransform, æKY kODErrOutOfMemory æC ODTransform::Invert,Not enough memory to allocate inverse matrix. æKY kODErrOutOfMemory æC ODTransform::InvertPoint,Not enough memory to allocate inverse matrix. æKY kODErrOutOfMemory æC ODTransform::NewTransform,Not enough memory to create a new transform. æKY kODErrOutOfMemory æC ODTranslation::GetTranslationOf,Cannot create a ODTypeList because the system is running out of memory. æKY kODErrOutOfMemory æC ODTranslation::Translate,Buffer pointed to by toData is not large enough to contain the translated data. æKY kODErrOutOfMemory æC ODTranslation::TranslateView,Cannot create a buffer to contain the translated data because the system is running out of memory. æKY kODErrOutOfMemory æC ODTypeList::AddLast,Could not add the argument type to the list. æKY kODErrOutOfMemory æC ODTypeList::CreateTypeListIterator,Could not create the iterator. æKY kODErrOutOfMemory æC ODTypeList::InitTypeList,Could not initialize the list. æKY kODErrOutOfMemory æC ODTypeList::InitTypeList ,Could not initialize the list. æKY kODErrOutOfMemory æC ODTypeListIterator::ODTypeListIterator,Could not construct this instance. æKY kODErrOutOfMemory æC ODUndo::AddActionToHistory,Initialization of ODUndo object failed; Couldn't allocate memory for action info. æKY kODErrOutOfMemory æC ODUndo::InitUndo,Not enough memory to allocated undo and redo stacks and shared memory. æKY kODErrOutOfMemory æC ODValueIterator::First,Not enough memory to begin the iteration. æKY kODErrOutOfMemory æC ODValueNameSpace::InitValueNameSpace,Out of memory. æKY kODErrOutOfMemory æC ODWindowState::Internalize,Out of memory æKY kODErrOutOfMemory æC ODWindowState::OpenWindows,Out of memory æKY kODErrInvalidDraft æC ODDocument::SaveToAPrevDraft,from is not above to. æKY kODErrInvalidDraft æC ODWindowState::CloseWindows,The specified draft is not valid. æKY kODErrInvalidDraft æC ODWindowState::Externalize,The specified draft is not valid. æKY kODErrInvalidDraft æC ODWindowState::Internalize,The specified draft is not valid. æKY kODErrInvalidDraft æC ODWindowState::OpenWindows,The specified draft is not valid. æKY kODErrInvalidDraft æC ODWindowState::SetDefaultWindowTitles,The specified draft is not valid. æKY kODErrIllegalNullStorageSystemInput æC Null Storage System object pointer. æKY kODErrInvalidPersistentObjectID æC ID does not correspond to any Persistent Object. æKY kODErrInvalidObjectType æC Not a pre-defined ObjectType. æKY kODErrIllegalClipboardCloneKind æC The cloneKind argument to ODClipboard::ActionDone, ActionUndone, or ActionRedone is not kODCloneCopy, kODCloneCut, or kODClone paste. æKY Error Codes2 Constants æKL kODErrInvalidDraft kODErrOutOfMemory kODErrInvalidDraft kODErrOutOfMemory kODErrInvalidDraft kODErrInvalidDraft kODErrInvalidDraft kODErrInvalidWindowState kODErrInvalidName kODErrInvalidName kODErrOutOfMemory kODErrWrongType kODErrOutOfMemory kODErrWrongType kODErrEmptyStack kODErrEmptyStack kODErrCannotMarkAction kODErrOutOfMemory kODErrOutOfMemory kODErrCannotAddAction kODErrIteratorOutOfSync kODErrIteratorOutOfSync kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrInvalidType kODErrOutOfMemory kODErrCannotDisposeTranslationMethod kODErrBadTranslationMethod kODErrOutOfMemory kODErrCannotTranslate kODErrCannotDisposeTranslationMethod kODErrOutOfMemory kODErrCannotTranslate kODErrOutOfMemory kODErrNumericError kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODNotValueFocussed kODNotValueFocussed kODErrInvalidProperty kODErrStorageUnitNotLocked kODErrInvalidStorageUnitKey kODErrUnfocusedStorageUnit kODErrInvalidType kODErrUnfocusedStorageUnit kODErrCannotAddType kODErrUnfocusedStorageUnit kODErrInvalidType kODErrUnfocusedStorageUnit kODErrUnfocusedStorageUnit kODErrInvalidStorageUnitKey kODErrStorageUnitLocked kODErrUnfocusedStorageUnit kODErrUnfocusedStorageUnit kODUnfocusedStorageUnit kODErrUnfocusedStorageUnit. kODErrInvalidValue kODUnfocusedStorageUnit kODUnfocusedStorageUnit kODErrUnfocusedStorageUnit kODErrUnfocusedStorageUnit kODErrInvalidType kODErrCannotAddType kODErrInvalidValue kODErrNotPromise kODErrUnfocusedStorageUnit kODErrInvalidStorageUnitRef kODUnfocusedStorageUnit kODUnfocusedStorageUnit kODErrInvalidPosCode kODErrInvalidPropertyName kODErrInvalidType kODErrInvalidValueIndex kODErrInvalidPosCode kODErrInvalidProperty kODErrInvalidType kODErrInvalidValueIndex kODErrInvalidType kODErrInvalidName kODErrUnfocusedStorageUnit kODErrUnfocusedStorageUnit kODErrUnfocusedStorageUnit kODErrInvalidDraftKey kODErrCloneNotStarted kODErrInvalidDraftKey kODErrCloneNotStarted kODErrCannotAddType kODErrValueExists kODErrUnfocusedStorageUnit kODErrInvalidType kODErrCannotAddProperty kODErrInvalidPropertyName kODCannotGetContainer kODInvalidContainerID kODCannotCreateContainer kODInvalidContainerID errAENotASpecialFunction errAEHandlerNotFound errAEHandlerNotFound errAENotASpecialFunction kODErrOutOfMemory kODErrOutOfMemory errAENotASpecialFunction errAEHandlerNotFound errAEHandlerNotFound kODErrNoGeometry kODErrNoGeometry kODErrNoShapeGeometry kODErrOutOfMemory kODErrInvalidGraphicsSystem kODErrNoGeometry kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrNoShapeGeometry kODErrNoGeometry kODErrOutOfMemory kODErrInvalidGraphicsSystem kODErrNoGeometry kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrZeroRefCount kODErrIteratorOutOfSync kODErrIteratorOutOfSync kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrInvalidUndo kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidUndo kODErrInvalidFrame kODErrInvalidLink kODErrInvalidFrame kODErrOutOfMemory kODErrCannotEmbed kODErrInvalidFrame kODErrCannotEmbed kODErrInvalidUndo kODErrOutOfMemory kODErrInvalidFrame kODErrOutOfMemory kODErrInvalidUndo kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFacet kODErrInvalidFacet kODErrInvalidFacet kODErrInvalidLink kODErrInvalidFacet kODErrInvalidFacet kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrCannotEmbed kODErrInvalidFacet kODErrInvalidPromise kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFocus kODErrInvalidFrame kODErrInvalidFocus kODErrInvalidFacet kODErrUnknownCanvasType kODErrInvalidFrame kODErrNotDragging kODErrInvalidFrame kODErrNotDragging kODErrNotDragging kODErrInvalidUndo kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrOutOfMemory kODErrCantLink kODErrInvalidLinkData kODErrInvalidFrame kODErrOutOfMemory kODErrCannotEmbed kODErrInvalidFrame kODErrInvalidFocus kODErrNotPrepared kODErrInvalidKind kODErrInvalidFrame kODErrInvalidFocus kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFocus kODErrNotPrepared kODErrOutOfMemory kODErrInvalidExtension kODErrInvalidExtension kODOutOfMemory kODErrKeyAlreadyExists kODErrOutOfMemory kODErrInvalidName kODErrInvalidName kODErrOutOfMemory kODOutOfMemory errAENoSuchObject kODErrInvalidPart kODErrInvalidPart kODErrOutOfMemory kODEInvalidPart kODEInvalidSemanticEvent kODEResolveError kODOutOfMemory kXODErrNotAValidPart kXODErrNotAValidPart kODErrOutOfMemory kODOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrOutOfMemory kODErrNoLinkSpecValue kODErrCorruptLinkSpecValue kODErrInvalidLinkKey kODErrInvalidLinkKey kODErrLinkBroken kODErrInvalidLinkKey kODLinkBroken kODErrOutOfMemory kODErrInvalidLinkKey kODErrInvalidDraftKey kODErrCloneNotStarted kODErrDraftNotSaved kODErrInvalidLinkKey kODErrInvalidLinkKey kODErrLinkBroken kODErrOutOfMemory kODLinkBroken kODErrOutOfMemory kODErrInvalidLinkKey kODErrInvalidLinkKey kODErrInvalidLinkKey kODErrInvalidDraftKey kODErrCloneNotStarted kODErrOutOfMemory kODErrOutOfMemory kODErrInvalidFocusModule kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFrame kODErrInvalidFacet kODErrInvalidFacet kODErrInvalidFacet kODErrInvalidFacet kODErrInvalidCanvas kODErrInvalidPositionCode kODInvalidFacet kODErrInvalidBase kODErrInvalidExtension kODErrInvalidWindowState kODErrInvalidStorageUnit kODErrInvalidStorageUnit kODErrInvalidRefCount kODErrInvalidStorageUnit kODErrInvalidRefCount kODErrInvalidStorageUnit kODErrInvalidRefCount kODErrInvalidRefCount kODErrInvalidStorageUnit kODErrInvalidRefCount kODErrInvalidRefCount kODErrInvalidRefCount kODErrInvalidRefCount kODErrCannotGetPart kODErrCannotGetLink kODErrCannotGetLink kODErrCannotGetFrame kODErrNoDraftProperties kODErrInvalidDraftKey kODErrCannotCreatePart kODErrCannotCreateLink kODErrCannotCreateFrame kODInvalidDraft kODErrCloningInProgress kODErrInvalidDraftKey kODErrOutstandingDraft kODErrInvalidDraft kODErrInvalidPosCode kODInvalidPermissions kODErrInvalidRefCount kODErrCannotChangePermissions kODErrNoDocumentProperties kODErrInvalidPermissions kODErrInvalidPermissions kODErrInvalidContainer kODErrInvalidBelowDraft kODErrOutstandingDraft kODErrNonEmptyDraft kODErrCannotCollapseDrafts kODErrInvalidFrame kODErrInvalidFrame kODErrOutOfMemory kODErrInvalidDispatchModule kODErrExistingDispatchModule kODErrInvalidDispatchModule kODErrExistingDispatchModule kODErrCannotOpenContainer kODErrInvalidDocument kODErrCannotCreateContainer kODErrInvalidClipboardKey kODErrOutOfMemory kODErrInvalidClipboardKey kODErrInvalidClipboardKey kODErrOutOfMemory kODErrInvalidClipboardKey kODErrInvalidGraphicsSystem kODErrInvalidGraphicsSystem kODErrInvalidGraphicsSystem kODOutOfMemory kODErrInvalidPlatformCanvas kODErrOutOfMemory kODErrInvalidFrame kODErrInvalidFocusSet kODErrInvalidFrame kODErrFocusNotRegistered kODErrFocusNotRegistered kODErrInvalidFrame kODErrInvalidFocusSet kODErrInvalidFrame kODErrExistingFocusModule kODErrorOutOfMemory kODErrOutOfMemory æC These are the standard error codes which are returned from the OpenDoc API. æKY kODErrInvalidDraft æC ODWindowState::SetDefaultWindowTitles,The specified draft is not valid. æKY kODErrOutOfMemory æC ODWindowState::OpenWindows,Out of memory æKY kODErrInvalidDraft æC ODWindowState::OpenWindows,The specified draft is not valid. æKY kODErrOutOfMemory æC ODWindowState::Internalize,Out of memory æKY kODErrInvalidDraft æC ODWindowState::Internalize,The specified draft is not valid. æKY kODErrInvalidDraft æC ODWindowState::Externalize,The specified draft is not valid. æKY kODErrInvalidDraft æC ODWindowState::CloseWindows,The specified draft is not valid. æKY kODErrInvalidWindowState æC ODWindowIterator::InitWindowIterator,The specified window state is not valid. æKY kODErrInvalidName æC ODValueNameSpace::ReadFromStorage,The stored name does not match that of the name space. æKY kODErrInvalidName æC ODValueNameSpace::ReadFromFile,The stored name does not match that of the name space. æKY kODErrOutOfMemory æC ODValueNameSpace::InitValueNameSpace,Out of memory. æKY kODErrWrongType æC ODValueIterator::Next,this is thrown if the type of the key does not match the type of the ODNameSpace with which the iterator was initialized. æKY kODErrOutOfMemory æC ODValueIterator::First,Not enough memory to begin the iteration. æKY kODErrWrongType æC ODValueIterator::First,this is thrown if the type of the key does not match the type of the ODNameSpace with which the iterator was initialized. æKY kODErrEmptyStack æC ODUndo::Undo,Undo stack is empty; Undo object was never initialized. æKY kODErrEmptyStack æC ODUndo::Redo,Redo stack is empty; Undo object was never initialized. æKY kODErrCannotMarkAction æC ODUndo::MarkActionHistory,ODUndo was never initialized properly. æKY kODErrOutOfMemory æC ODUndo::InitUndo,Not enough memory to allocated undo and redo stacks and shared memory. æKY kODErrOutOfMemory æC ODUndo::AddActionToHistory,Initialization of ODUndo object failed; Couldn't allocate memory for action info. æKY kODErrCannotAddAction æC ODUndo::AddActionToHistory,Currently already doing an undo or redo; trying to add a nested begin action. æKY kODErrIteratorOutOfSync æC ODTypeListIterator::Next,The ODTypeList instance was changed during the iteration. æKY kODErrIteratorOutOfSync æC ODTypeListIterator::First,The ODTypeList instance was changed during the iteration. æKY kODErrOutOfMemory æC ODTypeListIterator::ODTypeListIterator,Could not construct this instance. æKY kODErrOutOfMemory æC ODTypeList::InitTypeList ,Could not initialize the list. æKY kODErrOutOfMemory æC ODTypeList::InitTypeList,Could not initialize the list. æKY kODErrOutOfMemory æC ODTypeList::CreateTypeListIterator,Could not create the iterator. æKY kODErrInvalidType æC ODTypeList::AddLast,Argument type is not a valid ODType. æKY kODErrOutOfMemory æC ODTypeList::AddLast,Could not add the argument type to the list. æKY kODErrCannotDisposeTranslationMethod æC ODTranslation::TranslateView, TranslationMethod cannot be disposed. æKY kODErrBadTranslationMethod æC ODTranslation::TranslateView, Corrupted ODTranslationMethod. æKY kODErrOutOfMemory æC ODTranslation::TranslateView,Cannot create a buffer to contain the translated data because the system is running out of memory. æKY kODErrCannotTranslate æC ODTranslation::TranslateView,Data cannot be translated using the ODTranslationMethod. æKY kODErrCannotDisposeTranslationMethod æC ODTranslation::Translate, TranslationMethod cannot be disposed. æKY kODErrOutOfMemory æC ODTranslation::Translate,Buffer pointed to by toData is not large enough to contain the translated data. æKY kODErrCannotTranslate æC ODTranslation::Translate,Data cannot be translated using the ODTranslationMethod. æKY kODErrOutOfMemory æC ODTranslation::GetTranslationOf,Cannot create a ODTypeList because the system is running out of memory. æKY kODErrNumericError æC ODTransform::PreCompose, æKY kODErrOutOfMemory æC ODTransform::NewTransform,Not enough memory to create a new transform. æKY kODErrOutOfMemory æC ODTransform::InvertPoint,Not enough memory to allocate inverse matrix. æKY kODErrOutOfMemory æC ODTransform::Invert,Not enough memory to allocate inverse matrix. æKY kODErrOutOfMemory æC ODTransform::ODTransform, æKY kODNotValueFocussed æC ODStorageUnitView::GetOffset, æKY kODNotValueFocussed æC ODStorageUnitView::GetIDFromStorageUnitRef, æKY kODErrInvalidProperty æC ODStorageUnitCursor::InitStorageUnitCursor,Property Name is kODNULL. æKY kODErrStorageUnitNotLocked æC ODStorageUnit::Unlock,The Storage Unit is not locked. æKY kODErrInvalidStorageUnitKey æC ODStorageUnit::Unlock,Invalid ODStorageUnitKey. æKY kODErrUnfocusedStorageUnit æC ODStorageUnit::SetValue,this ODStorageUnit is not focused to a Value. æKY kODErrInvalidType æC ODStorageUnit::SetType,valueType is invalid (i.e., kODNULL). æKY kODErrUnfocusedStorageUnit æC ODStorageUnit::SetType,this ODStorageUnit is not focused to a Value. æKY kODErrCannotAddType æC ODStorageUnit::SetPromiseValue,Invalid Type. æKY kODErrUnfocusedStorageUnit æC ODStorageUnit::SetPromiseValue,this ODStorageUnit is not focused to a Property. æKY kODErrInvalidType æC ODStorageUnit::SetPromiseValue,valueType is invalid (kODNULL). æKY kODErrUnfocusedStorageUnit æC ODStorageUnit::SetOffset,this ODStorageUnit is not focused to a Value. æKY kODErrUnfocusedStorageUnit æC ODStorageUnit::RemoveStorageUnitRef,this ODStorageUnit is not focused to a Value. æKY kODErrInvalidStorageUnitKey æC ODStorageUnit::Lock,Invalid ODStorageUnitKey. æKY kODErrStorageUnitLocked æC ODStorageUnit::Lock,ODStorageUnit is already locked. æKY kODErrUnfocusedStorageUnit æC ODStorageUnit::InsertValue,this ODStorageUnit is not focused to a Value. æKY kODErrUnfocusedStorageUnit æC ODStorageUnit::IncrementGenerationNumber,this ODStorageUnit is not focused to a Value. æKY kODUnfocusedStorageUnit æC ODStorageUnit::GetWeakStorageUnitRef,this ODStorageUnit is not focused to a Value. æKY kODErrUnfocusedStorageUnit. æC ODStorageUnit::GetType, æKY kODErrInvalidValue æC ODStorageUnit::GetType, æKY kODUnfocusedStorageUnit æC ODStorageUnit::GetStrongStorageUnitRef, æKY kODUnfocusedStorageUnit æC ODStorageUnit::GetSize, æKY kODErrUnfocusedStorageUnit æC ODStorageUnit::GetProperty,this ODStorageUnit is not focused to a Property. æKY kODErrUnfocusedStorageUnit æC ODStorageUnit::GetPromiseValue,This ODStorageUnit object is not focused to a Property. æKY kODErrInvalidType æC ODStorageUnit::GetPromiseValue,valueType is kODNULL. æKY kODErrCannotAddType æC ODStorageUnit::GetPromiseValue,Invalid valueType. æKY kODErrInvalidValue æC ODStorageUnit::GetPromiseValue,Cannot focus to specified Value with valueType. æKY kODErrNotPromise æC ODStorageUnit::GetPromiseValue,The Value does not contain a Promise. æKY kODErrUnfocusedStorageUnit æC ODStorageUnit::GetOffset,This ODStorageUnit is not focused to a Value. æKY kODErrInvalidStorageUnitRef æC ODStorageUnit::GetIDFromStorageUnitRef,Invalid Storage Unit Reference. æKY kODUnfocusedStorageUnit æC ODStorageUnit::GetIDFromStorageUnitRef,this ODStorageUnit object is not focused to a Value. æKY kODUnfocusedStorageUnit æC ODStorageUnit::GetGenerationNumber,This ODStorageUnit object is not focused to a Value. æKY kODErrInvalidPosCode æC ODStorageUnit::Focus,Invalid position code. æKY kODErrInvalidPropertyName æC ODStorageUnit::Focus,No such Property. æKY kODErrInvalidType æC ODStorageUnit::Focus,No Value with such Type. æKY kODErrInvalidValueIndex æC ODStorageUnit::Focus,Invalid Value Index. æKY kODErrInvalidPosCode æC ODStorageUnit::Focus,Invalid position code. æKY kODErrInvalidProperty æC ODStorageUnit::Focus,No such Property. æKY kODErrInvalidType æC ODStorageUnit::Focus,No Value with this Type. æKY kODErrInvalidValueIndex æC ODStorageUnit::Focus,Invalid value index. æKY kODErrInvalidType æC ODStorageUnit::Exists,Invalid Value Type. æKY kODErrInvalidName æC ODStorageUnit::Exists,Invalid Property Name. æKY kODErrUnfocusedStorageUnit æC ODStorageUnit::DeleteValue,This ODStorageUnit is not focused to a Value. æKY kODErrUnfocusedStorageUnit æC ODStorageUnit::CreateCursorWithFocus,This ODStorageUnit is not focused to a Property or a Value. æKY kODErrUnfocusedStorageUnit æC ODStorageUnit::CountValues,This ODStorageUnit is not focused to a Property. æKY kODErrInvalidDraftKey æC ODStorageUnit::CloneTo,Invalid Clone. æKY kODErrCloneNotStarted æC ODStorageUnit::CloneTo,A Clone was started unsuccessfully. æKY kODErrInvalidDraftKey æC ODStorageUnit::CloneInto,Invalid Clone. æKY kODErrCloneNotStarted æC ODStorageUnit::CloneInto,A Clone was started unsuccessfully. æKY kODErrCannotAddType æC ODStorageUnit::AddValue,Cannot add Type to Storage Unit. æKY kODErrValueExists æC ODStorageUnit::AddValue,Value exists alreday. æKY kODErrUnfocusedStorageUnit æC ODStorageUnit::AddValue,This ODStorageUnit is not focused to a Property. æKY kODErrInvalidType æC ODStorageUnit::AddValue,type is kODNULL. æKY kODErrCannotAddProperty æC ODStorageUnit::AddProperty,Failure to add the given Property. æKY kODErrInvalidPropertyName æC ODStorageUnit::AddProperty,propertyName is kODNULL æKY kODCannotGetContainer æC ODStorageSystem::GetContainer,Invalid Container Type. æKY kODInvalidContainerID æC ODStorageSystem::GetContainer,Invalid Container ID. æKY kODCannotCreateContainer æC ODStorageSystem::CreateContainer,Invalid Container Type. æKY kODInvalidContainerID æC ODStorageSystem::CreateContainer,Invalid Container ID. æKY errAENotASpecialFunction æC ODSIHelper::RemoveSpecialHandler,Wrong keyword for a special function æKY errAEHandlerNotFound æC ODSIHelper::RemoveEventHandler,No handler found for an Apple event æKY errAEHandlerNotFound æC ODSIHelper::RemoveCoercionHandler,No coercion handler found æKY errAENotASpecialFunction æC ODSIHelper::InstallSpecialHandler,Wrong keyword for a special function æKY kODErrOutOfMemory æC ODSIHelper::InstallObjectAccessor,out of memory æKY kODErrOutOfMemory æC ODSIHelper::InitSIHelper,Not enough room to allocate internal structures. æKY errAENotASpecialFunction æC ODSIHelper::GetSpecialHandler,Wrong keyword for a special function æKY errAEHandlerNotFound æC ODSIHelper::GetEventHandler,No handler found for an Apple event æKY errAEHandlerNotFound æC ODSIHelper::GetCoercionHandler,No coercion handler found æKY kODErrNoGeometry æC ODShape::Union,Geometry mode is kODNeedsGeometry, but diffShape has no geometry. æKY kODErrNoGeometry æC ODShape::Transform,Shape doesn't have enough geometric information for this transformation. æKY kODErrNoShapeGeometry æC ODShape::Subtract,Geometry mode is kODNeedsGeometry, but diffShape has no geometry. æKY kODErrOutOfMemory æC ODShape::Subtract,not enough memory to subtract shapes. æKY kODErrInvalidGraphicsSystem æC ODShape::SetPlatformShape,not a valid graphics system. æKY kODErrNoGeometry æC ODShape::SetGeometryMode,If mode is set to kODNeedsGeometry but shape has no geometry. æKY kODErrOutOfMemory æC ODShape::Outset,Not enough memory to complete the operation. The shape will be unmodified. æKY kODErrOutOfMemory æC ODShape::NewShape,Not enough memory to create a new shape. æKY kODErrOutOfMemory æC ODShape::IsSameAs,not enough memory to compare shapes. æKY kODErrNoShapeGeometry æC ODShape::InverseTransform,Shape does not have enough geometric information to be transformed in this way. æKY kODErrNoGeometry æC ODShape::Intersect,Geometry mode is kODNeedsGeometry, but diffShape has no geometry. æKY kODErrOutOfMemory æC ODShape::Intersect,not enough memory to intersect shapes. æKY kODErrInvalidGraphicsSystem æC ODShape::GetPlatformShape,Graphics system unknown or not installed. æKY kODErrNoGeometry æC ODShape::CopyPolygon,Shape cannot be described as a polygon. æKY kODErrOutOfMemory æC ODShape::CopyPolygon, æKY kODErrOutOfMemory æC ODShape::CopyFrom,Not enough memory to copy shape data. æKY kODErrOutOfMemory æC ODShape::Copy, æKY kODErrOutOfMemory æC ODSession::Tokenize,out of memory æKY kODErrOutOfMemory æC ODSemanticInterface::SetTerminology,Not enough memory to copy list. æKY kODErrOutOfMemory æC ODSemanticInterface::InitSemanticInterface,Not enough memory to initialize object. æKY kODErrOutOfMemory æC ODSemanticInterface::ForwardEvent,not enough memory to store event in list of forwarded events. æKY kODErrZeroRefCount æC ODRefCntObject::Release,The reference count cannot be decremented because the reference count is already 0. æKY kODErrIteratorOutOfSync æC ODPlatformTypeListIterator::Next,The ODPlatformTypeList instance was changed during the iteration. æKY kODErrIteratorOutOfSync æC ODPlatformTypeListIterator::First,The ODPlatformTypeList instance was changed during the iteration. æKY kODErrOutOfMemory æC ODPlatformTypeListIterator::ODPlatformTypeListIterator,Could not construct this instance. æKY kODErrOutOfMemory æC ODPlatformTypeList::InitPlatformTypeList,Could not initialize the list. æKY kODErrOutOfMemory æC ODPlatformTypeList::CreatePlatformTypeListIterator,Could not create the iterator. æKY kODErrOutOfMemory æC ODPlatformTypeList::AddLast,Could not add the argument platform type to the list. æKY kODErrOutOfMemory æC ODPlatformTypeList::ODPlatformTypeList,Could not construct this instance. æKY kODErrInvalidUndo æC ODPart::WriteActionState,Not an undo action of this part. æKY kODErrInvalidFrame æC ODPart::ViewTypeChanged,frame is not a display frame of this part. æKY kODErrInvalidFrame æC ODPart::UsedShapeChanged,embeddedFrame is not an embeddedFrame of this part. æKY kODErrInvalidUndo æC ODPart::UndoAction,Not an undo action of this part. æKY kODErrInvalidFrame æC ODPart::SequenceChanged,frame is not a display frame of this part. æKY kODErrInvalidLink æC ODPart::RevealLink,This isn't one of my links. æKY kODErrInvalidFrame æC ODPart::RevealFrame,frame is not an embedded frame of this part. æKY kODErrOutOfMemory æC ODPart::RequestEmbeddedFrame,Not enough memory to embed a part. æKY kODErrCannotEmbed æC ODPart::RequestEmbeddedFrame,This part does not support embedding. æKY kODErrInvalidFrame æC ODPart::RemoveEmbeddedFrame,frame is not an embedded frame of this part. æKY kODErrCannotEmbed æC ODPart::RemoveEmbeddedFrame,This part does not support embedding. æKY kODErrInvalidUndo æC ODPart::RedoAction,Not an undo action of this part. æKY kODErrOutOfMemory æC ODPart::ReadPartInfo,Not enough memory to allocate partInfo. æKY kODErrInvalidFrame æC ODPart::ReadPartInfo,frame is not a display frame of this part. æKY kODErrOutOfMemory æC ODPart::ReadActionState,Not enough memory to internalize data. æKY kODErrInvalidUndo æC ODPart::ReadActionState,Not an undo action of this part. æKY kODErrInvalidFrame æC ODPart::PresentationChanged,"frame" isn't one of my display frames. æKY kODErrInvalidFrame æC ODPart::Open,"frame" isn't one of my display frames. æKY kODErrInvalidFacet æC ODPart::MouseWithin,facet is not a facet of this part. æKY kODErrInvalidFacet æC ODPart::MouseLeave,facet is not a facet of this part. æKY kODErrInvalidFacet æC ODPart::MouseEnter,facet is not a facet of this part. æKY kODErrInvalidLink æC ODPart::LinkUpdated,This isn't one of my links. æKY kODErrInvalidFacet æC ODPart::HighlightChanged,"facet" is not a facet of this part. æKY kODErrInvalidFacet æC ODPart::HandleEvent,facet is not a facet of this part. æKY kODErrInvalidFrame æC ODPart::HandleEvent,frame is not a display frame of this part. æKY kODErrInvalidFrame æC ODPart::GetPrintResolution,frame is not a display frame of this part. æKY kODErrInvalidFrame æC ODPart::GetContainingPartProperties,frame is not an embedded frame of this part. æKY kODErrCannotEmbed æC ODPart::GetContainingPartProperties,This part does not support embedding. æKY kODErrInvalidFacet æC ODPart::GeometryChanged,facet is not a facet of this part. æKY kODErrInvalidPromise æC ODPart::FulfillPromise,The part did not make this promise. æKY kODErrInvalidFrame æC ODPart::FrameShapeChanged,frame is not a display frame of this part. æKY kODErrInvalidFrame æC ODPart::FocusLost,ownerFrame is not a display frame of this part. æKY kODErrInvalidFocus æC ODPart::FocusLost,Part doesn't own this focus. æKY kODErrInvalidFrame æC ODPart::FocusAcquired,ownerFrame is not a display frame of this part. æKY kODErrInvalidFocus æC ODPart::FocusAcquired,Part cannot own this focus. æKY kODErrInvalidFacet æC ODPart::FacetRemoved,facet is not a facet of this part. æKY kODErrUnknownCanvasType æC ODPart::FacetAdded,The part is unable to render itself on the facet's canvas. æKY kODErrInvalidFrame æC ODPart::EmbeddedFrameSpec,embeddedFrame is not an embedded frame of this part. æKY kODErrNotDragging æC ODPart::Drop,Part hasn't received a DragEnter message. æKY kODErrInvalidFrame æC ODPart::Draw,"frame" isn't one of my display frames. æKY kODErrNotDragging æC ODPart::DragWithin,Part has not received a DragEnter call. æKY kODErrNotDragging æC ODPart::DragLeave,Part has not received a DragEnter call. æKY kODErrInvalidUndo æC ODPart::DisposeActionState,Not an undo action of this part. æKY kODErrInvalidFrame æC ODPart::DisplayFrameRemoved,frame is not a display frame of this part. æKY kODErrInvalidFrame æC ODPart::DisplayFrameConnected,frame is not a display frame of this part. æKY kODErrInvalidFrame æC ODPart::DisplayFrameClosed,frame is not a display frame of this part. æKY kODErrOutOfMemory æC ODPart::CreateLink,Not enough memory to allocate link object. æKY kODErrCantLink æC ODPart::CreateLink,Part does not support linking protocol. æKY kODErrInvalidLinkData æC ODPart::CreateLink,Could not identify content for link. æKY kODErrInvalidFrame æC ODPart::CreateEmbeddedFramesIterator,frame is not a display frame of this part. æKY kODErrOutOfMemory æC ODPart::CreateEmbeddedFramesIterator,Not enough memory to allocate iterator. æKY kODErrCannotEmbed æC ODPart::CreateEmbeddedFramesIterator,This part does not support embedding. æKY kODErrInvalidFrame æC ODPart::CommitRelinquishFocus,ownerFrame is not a display frame of this part. æKY kODErrInvalidFocus æC ODPart::CommitRelinquishFocus,Part doesn't own this focus. æKY kODErrNotPrepared æC ODPart::CommitRelinquishFocus,Part hasn't prepared to relinqush focus. æKY kODErrInvalidKind æC ODPart::ChangeKind,Part does not support that kind of content. æKY kODErrInvalidFrame æC ODPart::BeginRelinquishFocus,ownerFrame is not a display frame of this part. æKY kODErrInvalidFocus æC ODPart::BeginRelinquishFocus,Part doesn't own this focus. æKY kODErrInvalidFrame æC ODPart::AttachSourceFrame,Either frame or sourceFrame is not a display frame of this part. æKY kODErrInvalidFrame æC ODPart::AdjustMenus,frame is not a display frame of this part. æKY kODErrInvalidFrame æC ODPart::AdjustBorderShape,embeddedFrame is not an embeddedFrame of this part. æKY kODErrInvalidFrame æC ODPart::AbortRelinquishFocus,ownerFrame is not a display frame of this part. æKY kODErrInvalidFocus æC ODPart::AbortRelinquishFocus,Part doesn't own this focus. æKY kODErrNotPrepared æC ODPart::AbortRelinquishFocus,Part hasn't prepared to relinqush focus. æKY kODErrOutOfMemory æC ODObjectNameSpace::InitObjectNameSpace,Out of memory. æKY kODErrInvalidExtension æC ODObject::ReleaseExtension,not an extension that this object knows about æKY kODErrInvalidExtension æC ODObject::GetExtension,not an extension that this object knows about æKY kODOutOfMemory æC ODNameSpaceManager::InitNameSpaceManager,Out of memory. æKY kODErrKeyAlreadyExists æC ODNameSpaceManager::CreateNameSpace,An ODNameSpace with that name already exists. æKY kODErrOutOfMemory æC ODNameSpaceManager::CreateNameSpace,Not enough memory æKY kODErrInvalidName æC ODNameSpace::ReadFromStorage,The stored name does not match that of the name space. æKY kODErrInvalidName æC ODNameSpace::ReadFromFile,The stored name does not match that of the name space. æKY kODErrOutOfMemory æC ODNameSpace::InitNameSpace,Out of memory. æKY kODOutOfMemory æC ODNameResolver::Resolve,Couldn't allocate needed internal structures. æKY errAENoSuchObject æC ODNameResolver::Resolve,Invalid ODPart* or part does not support the Semantic Interface extension. æKY kODErrInvalidPart æC ODNameResolver::GetContextInfo,Not a valid part æKY kODErrInvalidPart æC ODNameResolver::DisposeToken,Token does not contain a valid part description. æKY kODErrOutOfMemory æC ODNameResolver::CreateSwapToken,Out of Memory æKY kODEInvalidPart æC ODMessageInterface::Send,Invalid part. æKY kODEInvalidSemanticEvent æC ODMessageInterface::Send,Invalid AppleEvent (not created with ODMessageInterface::CreateEvent ). æKY kODEResolveError æC ODMessageInterface::ProcessSemanticEvent,Couldn't determine correct object to dispatch to. æKY kODOutOfMemory æC ODMessageInterface::InitMessageInterface,Not enough memory for needed storage. æKY kXODErrNotAValidPart æC ODMessageInterface::CreatePartObjSpec,ODPart* was not valid. æKY kXODErrNotAValidPart æC ODMessageInterface::CreatePartAddrDesc,ODPart* was not valid. æKY kODErrOutOfMemory æC ODMessageInterface::CreateOSAObject,Not enough memory to create the object. æKY kODOutOfMemory æC ODMessageInterface::CreateEvent,Couldn't allocate memory for the event. æKY kODErrOutOfMemory æC ODMenuBar::AddSubMenu,Out of memory æKY kODErrOutOfMemory æC ODMenuBar::AddMenuLast,Out of memory æKY kODErrOutOfMemory æC ODMenuBar::AddMenuBefore,Out of memory æKY kODErrNoLinkSpecValue æC ODLinkSpec::ReadLinkSpec,Focused property does not contain a link specification value. æKY kODErrCorruptLinkSpecValue æC ODLinkSpec::ReadLinkSpec,Focused property contains an invalid link specification value. æKY kODErrInvalidLinkKey æC ODLinkSource::UseLinkEdition, æKY kODErrInvalidLinkKey æC ODLinkSource::Unlock, æKY kODErrLinkBroken æC ODLinkSource::ShowSourceContent,Cannot locate the source of the link. æKY kODErrInvalidLinkKey æC ODLinkSource::ReadLinkEdition, æKY kODLinkBroken æC ODLinkSource::InitLinkSourceFromStorage,The associated link object could not be found. æKY kODErrOutOfMemory æC ODLinkSource::InitLinkSource,Out of memory. æKY kODErrInvalidLinkKey æC ODLinkSource::GetContentStorageUnit, æKY kODErrInvalidDraftKey æC ODLinkSource::CloneTo,Invalid Clone. æKY kODErrCloneNotStarted æC ODLinkSource::CloneTo,A Clone was started unsuccessfully. æKY kODErrDraftNotSaved æC ODLinkManager::CreateLink,A link could not be created because the source document has never been saved. æKY kODErrInvalidLinkKey æC ODLink::UpdateLinkEdition, æKY kODErrInvalidLinkKey æC ODLink::Unlock, æKY kODErrLinkBroken æC ODLink::ShowSourceContent,Cannot locate the source of the link. æKY kODErrOutOfMemory æC ODLink::RegisterDependent,Not enough memory æKY kODLinkBroken æC ODLink::InitLinkFromStorage,The associated link source object could not be found. æKY kODErrOutOfMemory æC ODLink::InitLink,Out of memory. æKY kODErrInvalidLinkKey æC ODLink::GetLinkEdition, æKY kODErrInvalidLinkKey æC ODLink::GetContentStorageUnit, æKY kODErrInvalidLinkKey æC ODLink::CreateLinkEdition, æKY kODErrInvalidDraftKey æC ODLink::CloneTo,Invalid Clone. æKY kODErrCloneNotStarted æC ODLink::CloneTo,A Clone was started unsuccessfully. æKY kODErrOutOfMemory æC ODFocusSetIterator::First,Not enough memory to allocate the LinkedListIterator æKY kODErrOutOfMemory æC ODFocusSet::Add, æKY kODErrInvalidFocusModule æC ODFocusOwnerIterator::InitFocusOwnerIterator,The specified focus module is invalid. æKY kODErrInvalidFrame æC ODFocusModule::UnsetFocusOwnership,The specified frame is invalid æKY kODErrInvalidFrame æC ODFocusModule::TransferFocusOwnership,The specified frame is invalid æKY kODErrInvalidFrame æC ODFocusModule::SetFocusOwnership,The specified frame is invalid æKY kODErrInvalidFacet æC ODFacet::RemoveFacet,"facet" is not a child of the receiver. æKY kODErrInvalidFacet æC ODFacet::MoveBehind,"child" or "sibling" is not a valid child facet of the receiver. æKY kODErrInvalidFacet æC ODFacet::MoveBefore,"child" or "sibling" is not a valid child facet of the receiver. æKY kODErrInvalidFacet æC ODFacet::Invalidate,Can't find facet for parent canvas. æKY kODErrInvalidCanvas æC ODFacet::GetCanvas,Neither this facet or any of its parents had a canvas. æKY kODErrInvalidPositionCode æC ODFacet::CreateEmbeddedFacet,"position" is not a valid position code. æKY kODInvalidFacet æC ODFacet::CreateEmbeddedFacet,"siblingFacet" is not a child of the receiver. æKY kODErrInvalidBase æC ODExtension::Release,Not a valid base object. æKY kODErrInvalidExtension æC ODExtension::CheckValid,This is an invalid extension and should not be used by any clients. The client should attempt to get the extension from the same base object she got it from before. æKY kODErrInvalidWindowState æC ODDragItemIterator::ODDragItemIterator,The specified window state is not valid. æKY kODErrInvalidStorageUnit æC ODDraft::RemoveStorageUnit,Invalid storageUnit. æKY kODErrInvalidStorageUnit æC ODDraft::RemovePart,Invalid ODPart with no ODStorageUnit associated with it. æKY kODErrInvalidRefCount æC ODDraft::RemovePart,Refcount of part is not 1. æKY kODErrInvalidStorageUnit æC ODDraft::RemoveLinkSource,Invalid ODLinkSource with no ODStorageUnit associated with it. æKY kODErrInvalidRefCount æC ODDraft::RemoveLinkSource,Refcount of link is not 1. æKY kODErrInvalidStorageUnit æC ODDraft::RemoveLink,Invalid ODLink with no ODStorageUnit associated with it. æKY kODErrInvalidRefCount æC ODDraft::RemoveLink,Refcount of link is not 1. æKY kODErrInvalidRefCount æC ODDraft::RemoveFrame,RefCount of frame is not 1. æKY kODErrInvalidStorageUnit æC ODDraft::RemoveFrame,Invalid ODFrame with no ODStorageUnit associated with it. æKY kODErrInvalidRefCount æC ODDraft::ReleaseStorageUnit,Refcount of storageUnit is not 0. æKY kODErrInvalidRefCount æC ODDraft::ReleasePart,RefCount of part is not 0. æKY kODErrInvalidRefCount æC ODDraft::ReleaseLink,Refcount of link is not 0. æKY kODErrInvalidRefCount æC ODDraft::ReleaseFrame,RefCount of object is not 0. æKY kODErrCannotGetPart æC ODDraft::GetPart,Cannot create ODPart object. æKY kODErrCannotGetLink æC ODDraft::GetLinkSource,Cannot create ODLink object. æKY kODErrCannotGetLink æC ODDraft::GetLink,Cannot create ODLink object. æKY kODErrCannotGetFrame æC ODDraft::GetFrame,Cannot create ODFrame object. æKY kODErrNoDraftProperties æC ODDraft::GetDraftProperties,Draft Properties Storage Unit cannot be created. æKY kODErrInvalidDraftKey æC ODDraft::EndClone, æKY kODErrCannotCreatePart æC ODDraft::CreatePart,Cannot create ODPart object. æKY kODErrCannotCreateLink æC ODDraft::CreateLinkSource,Cannot create the ODLinkSource or companion ODLink object. æKY kODErrCannotCreateFrame æC ODDraft::CreateFrame,Cannot create ODFrame object. æKY kODInvalidDraft æC ODDraft::ChangedFromPrev,Invalid Draft. æKY kODErrCloningInProgress æC ODDraft::BeginClone,Another Clone has started already. æKY kODErrInvalidDraftKey æC ODDraft::AbortClone,Invalid Clone. æKY kODErrOutstandingDraft æC ODDocument::SaveToAPrevDraft,There is one or more outstanding Draft between from (exclusive) and to (exclusive). æKY kODErrInvalidDraft æC ODDocument::SaveToAPrevDraft,from is not above to. æKY kODErrInvalidPosCode æC ODDocument::GetDraft,Invalid relative position. æKY kODInvalidPermissions æC ODDocument::GetDraft,Invalid permissions. æKY kODErrInvalidRefCount æC ODDocument::GetDraft,draft does not have a valid refCount. æKY kODErrCannotChangePermissions æC ODDocument::GetDraft,Cannot change permission on draft if it is gotten again with a different permissions. æKY kODErrNoDocumentProperties æC ODDocument::GetDocumentProperties,Cannot create ODStorageUnit for Document Properties. æKY kODErrInvalidPermissions æC ODDocument::GetBaseDraft,Invalid permissions. æKY kODErrInvalidPermissions æC ODDocument::CreateDraft,Exclusive-Write-Only below is not released. æKY kODErrInvalidContainer æC ODDocument::CreateDraft,Container does not support creation of new drafts. æKY kODErrInvalidBelowDraft æC ODDocument::CreateDraft,below is kODNULL or below is not the Top Draft of the Document. æKY kODErrOutstandingDraft æC ODDocument::CollapseDrafts,There is one or more outstanding Draft (i.e., refCount >= 1) between from and to. æKY kODErrNonEmptyDraft æC ODDocument::CollapseDrafts,Non-empty draft between from and to. æKY kODErrCannotCollapseDrafts æC ODDocument::CollapseDrafts,from is not above to. æKY kODErrInvalidFrame æC ODDispatcher::UnregisterIdle,The specified frame is invalid æKY kODErrInvalidFrame æC ODDispatcher::RegisterIdle,The specified frame is invalid æKY kODErrOutOfMemory æC ODDispatcher::InitDispatcher,Out of memory æKY kODErrInvalidDispatchModule æC ODDispatcher::AddMonitor,specified dispatch module is invalid. æKY kODErrExistingDispatchModule æC ODDispatcher::AddMonitor,module is already installed. æKY kODErrInvalidDispatchModule æC ODDispatcher::AddDispatchModule,specified dispatch module is invalid. æKY kODErrExistingDispatchModule æC ODDispatcher::AddDispatchModule,module is already installed. æKY kODErrCannotOpenContainer æC ODContainer::Open,Cannot open the physical Container. æKY kODErrInvalidDocument æC ODContainer::GetDocument,Cannot get desired Document because the id is invalid. æKY kODErrCannotCreateContainer æC ODContainer::Create,Cannot create the physical Container. æKY kODErrInvalidClipboardKey æC ODClipboard::SetPlatformClipboard,The argument clipboard key is not valid. æKY kODErrOutOfMemory æC ODClipboard::SetPlatformClipboard,Out of Memory æKY kODErrInvalidClipboardKey æC ODClipboard::GetContentStorageUnit,The argument clipboard key is not valid. æKY kODErrInvalidClipboardKey æC ODClipboard::ExportClipboard,The argument clipboard key is not valid. æKY kODErrOutOfMemory æC ODClipboard::ExportClipboard,Out of Memory æKY kODErrInvalidClipboardKey æC ODClipboard::Clear,The argument clipboard key is not valid. æKY kODErrInvalidGraphicsSystem æC ODCanvas::SetPlatformCanvas,The graphics system is unknown. æKY kODErrInvalidGraphicsSystem æC ODCanvas::GetPlatformPrintJob,The graphics system is unknown; or there is no print job associated with it. æKY kODErrInvalidGraphicsSystem æC ODCanvas::GetPlatformCanvas,The graphics system is unknown; or there is no platform canvas associated with this graphics system. æKY kODOutOfMemory æC ODCanvas::ODCanvas,cannot allocate ODCanvas object. æKY kODErrInvalidPlatformCanvas æC ODCanvas::ODCanvas, æKY kODErrOutOfMemory æC ODBinding::InitBinding,Out of memory. æKY kODErrInvalidFrame æC ODArbitrator::TransferFocusSet, æKY kODErrInvalidFocusSet æC ODArbitrator::TransferFocusSet, æKY kODErrInvalidFrame æC ODArbitrator::TransferFocus, æKY kODErrFocusNotRegistered æC ODArbitrator::RequestFocusSet,One of the requested foci is not registered. æKY kODErrFocusNotRegistered æC ODArbitrator::RequestFocus,One of the requested foci is not registered. æKY kODErrInvalidFrame æC ODArbitrator::RelinquishFocusSet, æKY kODErrInvalidFocusSet æC ODArbitrator::RelinquishFocusSet, æKY kODErrInvalidFrame æC ODArbitrator::RelinquishFocus, æKY kODErrExistingFocusModule æC ODArbitrator::RegisterFocus,A focus module already exists for that focus. æKY kODErrorOutOfMemory æC ODArbitrator::InitArbitrator,Out of memory. æKY kODErrOutOfMemory æC ODArbitrator::CreateOwnerIterator,Out of memory æKY Error Codes - General Constants æKL kODErrIteratorNotInitialized kODErrIllegalNullFacetInput kODErrIllegalNullFrameInput kODErrValueIndexOutOfRange æC General Error Codes æKY kODErrIteratorNotInitialized æC A method was called on an uninitialized iterator. æKY kODErrIllegalNullFacetInput æC An OpenDoc API call was made which was expecting an ODFacet object as one of its parameters and got NULL instead. æKY kODErrIllegalNullFrameInput æC An OpenDoc API call was made which was expecting an ODFrame object as one of its parameters and got NULL instead. æKY kODErrValueIndexOutOfRange æC An OpenDoc API call was made which was expecting an value within a certain range of numbers (depends on the object and the situation) and instead got a value outside that range of numbers. æKY General Constants æKL kODFalse kODTrue kODNULL kODsmSystemScript kODsmScriptLang kODTinyIconSize kODSmallIconSize kODLargeIconSize kODThumbnailSize kODNULLID kODKeyNotGranted kODNoEditor kODTraditionalMacText æKY kODFalse æC An ODBoolean constant equal to 0 . æKY kODTrue æC An ODBoolean constant equal to 1. æKY kODNULL æC The value NULL. æKY kODsmSystemScript æC A Designator for the system script. æKY kODsmScriptLang æC The current script language. æKY kODTinyIconSize æC The size for tiny icons equal to 12x12 pixels. æKY kODSmallIconSize æC The size for small icons equal to 16x16 pixels. æKY kODLargeIconSize æC The size for large icons equal to 32x32 pixels. æKY kODThumbnailSize æC The size for thumb nails equal to 64x64 pixels. æKY kODNULLID æC An invalid ID or a null ID. æKY kODKeyNotGranted æC A storage unit key has not yet been granted, or could not be granted. æKY kODNoEditor æC A distinguished ODEditor value denoting no part editor. æKY kODTraditionalMacText æC Constant for ODITextFormat field of ODIText indicating the traditional Macintosh international text standard of script code/lang code/string. æKY Layout Constants æKL kODPresDefault kNewGroup æC Constants used in the Layout protocols. æKY kODPresDefault æC The default presentation for a frame. æKY kNewGroup æC Used in the ODPart::CreateEmbeddedFrame() call. Pass as the frameGroupID parameter to ask the containing part to put the created frame in a new frame group. æKY Messaging - Properties for Part Info Dialog Constants æKL kODPCategory kODPSize kODPCreationDate kODPModDate kODPAuthor kODPIcon kODPName kODPKind kODPEditor kODPComments kODPView kODPIsFrozen kODPIsStationery æC Apple Event Object Model properties corresponding to the elements of the Part Info dialog. æKY kODPCategory æC = 'cate'. The category of a selected part. æKY kODPSize æC = 'size'. The size of a selected part. æKY kODPCreationDate æC = 'crdt'. The creation date of a selected part. æKY kODPModDate æC = 'modt'. The modification date of a selected part. æKY kODPAuthor æC = 'auth'. The author of a selected part. æKY kODPIcon æC = 'icon'. The icon of a selected part. æKY kODPName æC = 'pnam'. The name of a selected part. æKY kODPKind æC = 'pknd'. The kind of a selected part. æKY kODPEditor æC = 'edtr'. The editor of a selected part. æKY kODPComments æC = 'cmnt'. A comment about a selected part. æKY kODPView æC = 'view'. The type of view of a selected part (Frame, Icon etc). æKY kODPIsFrozen æC = 'frzn'. Whether a selected part is "frozen" or not. æKY kODPIsStationery æC = pIsStationeryPad. Is the stationery flag of the selected part set? æKY Messaging subsystem Constants æKL kODAppShell cPart cDraft typeUserToken æC Constants of the Messaging subsystem æKY kODAppShell æC Used to represent the shell application, when calling methods of the messaging subsystem which normally take an ODPart* as an argument. æKY cPart æC = 'part'. An AppleEvent Object Model property. æKY cDraft æC = 'drft'. An AppleEvent Object Model property. æKY typeUserToken æC Reserved descriptorType for use by OpenDoc. æKY Name Spaces Constants æKL kODNSTypeISOStr kODNSTypeSLong æKY kODNSTypeISOStr æC An indicator of a name space with keys that are of type ISO String. æKY kODNSTypeSLong æC An indicator of a name space with keys that are of type signed long. æKY ODPart - Persistent Properties Constants æKL kODPropIsStationery kODPropCustomIcon kODPropPreferredKind kODPropContents kODPropPreferredEditor kODPropDisplayFrames æKY kODPropIsStationery æC Indicates whether a part should act as a stationery. æKY kODPropCustomIcon æC The custom icon property on a part's storageUnit. If a user sets the custom icon of a part using a script, this property is where that custom icon is stored. The utility functions ODGetIconFamily and ODSetIconFamily can be used to manipulate the custom icon of a part; they in turn read/write to this property. æKY kODPropPreferredKind æC A property containing a content type value identifying one of the values in the kODContents property as the value that should be internalized by an editor bound to this part. This property, if present, overrides the ordering of values in the kODContents property. æKY kODPropContents æC The contents property. All Part contents should be stored in a value of this property. Multiple values should be used ONLY as additional standalone alternate representations of the entire contents. Please see the "Part Storage Model" recipe document for more details. æKY kODPropPreferredEditor æC This property is maintained by the Binding subsystem and indicates which editor last manipulated the part. æKY kODPropDisplayFrames æC This is an annotation on every part's storageUnit which contains a list of weak references to the part's display frames. The part is responsible for maintaining this list. Please see the "Display Frame 'ternalization" recipe document for more info. æKY Standard Persistent Types Constants æKL kODBoolean kODUShort kODSShort kODULong kODSLong kODISOStr kODASCIIText kODIntlText kODTime_T kODPoint kODRect kODPolygon kODIconFamily kODTransform kODEditor kODStrongStorageUnitRef kODWeakStorageUnitRef kODPartObject kODFrameObject kODNonPersistentFrame kODMacIText æC These are the standard persistent types which should be used for all OpenDoc metadata. The OpenDoc Document Exchange Initiative may have more up to date information on the specific formats of these types. æKY kODBoolean æC one byte. 0 == FALSE. æKY kODUShort æC unsigned two byte integer. æKY kODSShort æC signed two byte integer æKY kODULong æC unsigned four byte integer æKY kODSLong æC signed four byte integer æKY kODISOStr æC Null Terminated 7-bit ASCII. This is a non-Uservisible string. æKY kODASCIIText æC ASCII text. Not null terminated. Determine the size of the text directly from the size of the value. æKY kODIntlText æC User visible, internationalizable string. æKY kODTime_T æC Seconds since 1970 æKY kODPoint æC two 16.16 coordinates æKY kODRect æC two ODPoints, topleft and bottomright æKY kODPolygon æC list of countours, each of which is a list of points. Clockwise in the standard coordinate system. æKY kODIconFamily æC Family of Icons, 16x16, 32x32, different bit depths etc. Macintosh specific. æKY kODTransform æC 3x3 matrix of 16.16 number æKY kODEditor æC A platform specific string which is used to map 1-1 to a shared library representing a part editor installed on that platform. æKY kODStrongStorageUnitRef æC A strong storageUnit reference. four bytes. See storageUnit API for more detail. æKY kODWeakStorageUnitRef æC A weak storageUnit reference. four bytes. See storageUnit API for more detail. æKY kODPartObject æC Indicates that the Persistent Object is a Part. æKY kODFrameObject æC Indicates that the Persistent Object is a frame. æKY kODNonPersistentFrame æC Indicates that the object to be created is a non-persistent frame. æKY kODMacIText æC Traditional Macintosh representation of international text: two bytes script code, two bytes language code, and a variable length array of bytes. æKY Standard Persistent Properties Constants æKL kODPropDraftSavedDate kODPropPreODMetaData kODPropPreAnnotation kODPropName kODPropComments æC See also ODPart - Standard Properties and Data Interchange - Standard Properties æKY kODPropDraftSavedDate æC This property is a property on the DraftProperties storageUnit which indicates the DraftSaved date for Drafts which were "Saved" in the Drafts dialog. æKY kODPropPreODMetaData æC This is an ISO String prefix which used by all OpenDoc Metadata property constants. This ensures that properties with this prefix on cloned storageUnits are copied over automatically. This is not intended to be used by part editor developers. æKY kODPropPreAnnotation æC This is an ISO String prefix which used by part editors to indicate a property which should be automatically copied when its storageUnit is cloned. This ensures that properties with this prefix on cloned storageUnits are copied over automatically. This is intended to be used by part editor developers. æKY kODPropName æC Used to store a name property on persistent objects such as parts. æKY kODPropComments æC Used to store a comments property on persistent objects such as parts. æKY Storage Subsystem - Errors Constants æKL kODErrCannotFindLinkSourceEdition kODErrCannotFindLinkSource kODErrAlreadyImportedLink æC Errors returned by storage subsystem methods. æKY kODErrCannotFindLinkSourceEdition æC Cannot locate the source of cross document link because the Edition file does not exist [Mac-specific]. æKY kODErrCannotFindLinkSource æC Cannot locate source of cross-document link. æKY kODErrAlreadyImportedLink æC Cannot create link due to internal error. æKY Storage System Constants æKL kDPNone kDPTransient kDPReadOnly kDPSharedWrite kDPExclusive kInvisibleBlocks kAllBlocks kVisibleBlocks kODDefaultDocumentID kODPosUndefined kODPosSame kODPosAll kODPosFirstSib kODPosLastSib kODPosNextSib kODPosPrevSib kODPosMWrap kODIDAll kODIndexAll kODTypeAll kODPosFirstBelow kODPosLastBelow kODPosFirstAbove kODPosLastAbove kODPosTop kODStorageUnitRefSize kODCanTranslate kODCannotTranslate kODNative kODPosReserved11 kODPosReserved12 kODPosReserved13 kODPosReserved14 kODPosReserved15 æC These constants are used for the Storage System. æKY kDPNone æC No access privilege on a Draft. æKY kDPTransient æC No access privilege on a Draft. æKY kDPReadOnly æC Read-only access privilege on a Draft. æKY kDPSharedWrite æC Shared access on a Draft. æKY kDPExclusive æC Exclusive read-write access on a Draft. æKY kInvisibleBlocks æC Only Blocks with no references to them should be purged. æKY kAllBlocks æC All blocks should be purged. æKY kVisibleBlocks æC Only blocks with references to them should be purged. æKY kODDefaultDocumentID æC Default Document ID. æKY kODPosUndefined æC Undefined Property or Value context. æKY kODPosSame æC Maintain the same Property or Value context. æKY kODPosAll æC Focus to all Properties or all Values. æKY kODPosFirstSib æC Set the context to the first Property of the Storage Unit or the first Value of the Storage Unit. æKY kODPosLastSib æC Set the context to the last Property of the Storage Unit or the last Value of the Storage Unit. æKY kODPosNextSib æC Set the context to the next Property of the Storage Unit or the first next of the Storage Unit with respect to the current context. æKY kODPosPrevSib æC Set the context to the previous Property of the Storage Unit or the first previous of the Storage Unit with respect to the current context. æKY kODPosMWrap æC Wraps iteration of Properties or Values. æKY kODIDAll æC Set the context to all Values. æKY kODIndexAll æC Set the context to all Values. æKY kODTypeAll æC Set the context to all Values. æKY kODPosFirstBelow æC Used to refer to the draft below the current draft. æKY kODPosLastBelow æC Used to refer to the draft below the current draft. æKY kODPosFirstAbove æC Used to refer to the draft above the current draft. æKY kODPosLastAbove æC Used to refer to the draft above the current draft. æKY kODPosTop æC Used to refer to the top draft in a document. æKY kODStorageUnitRefSize æC Size of ODStorageUnitRef æKY kODCanTranslate æC result code showing that translation is allowed with the given types. æKY kODCannotTranslate æC Result code showing that translation is not allowed given the types. æKY kODNative æC Result code showing that the part handles the data directly. æKY kODPosReserved11 æC Reserved for future use. æKY kODPosReserved12 æC Reserved for future use. æKY kODPosReserved13 æC Reserved for future use. æKY kODPosReserved14 æC Reserved for future use. æKY kODPosReserved15 æC Reserved for future use. æKY UI Subsystem - Standard Mac Events Constants æKL kODEvtNull kODEvtMouseDown kODEvtMouseUp kODEvtKeyDown kODEvtKeyUp kODEvtAutoKey kODEvtUpdate kODEvtDisk kODEvtActivate kODEvtOS æC These constants are simply redefinitions of the standard Macintosh event codes. æKY kODEvtNull æC A null event. Represents idle time to parts. æKY kODEvtMouseDown æC A mouse down event. See Inside Mac. æKY kODEvtMouseUp æC A mouse up event. See Inside Mac. æKY kODEvtKeyDown æC A key down event. See Inside Mac. æKY kODEvtKeyUp æC A key up event. See Inside Mac. æKY kODEvtAutoKey æC An autokey event. See Inside Mac. æKY kODEvtUpdate æC An update event. See Inside Mac. æKY kODEvtDisk æC A disk event. See Inside Mac. æKY kODEvtActivate æC An activate event. See Inside Mac. æKY kODEvtOS æC An OS Event (suspend/resume and mouseMoved). See Inside mac. æKY UI Subsystem - Additional OpenDoc Events Constants æKL kODEvtMenu kODEvtMouseDownEmbedded kODEvtMouseUpEmbedded kODEvtMouseDownBorder kODEvtMouseUpBorder kODEvtWindow kODEvtMouseEnter kODEvtMouseWithin kODEvtMouseLeave æC OpenDoc defines some additional events, over and above the standard Macintosh events. æKY kODEvtMenu æC An adaptation of a mouse down in the menu bar, or the equivalent Command-Key combination. Message field of event record contains menu in high word and item in low word. Other fields of event record are as for mouse down or key down. æKY kODEvtMouseDownEmbedded æC A mouse down in an embedded facet. Sent to containing facet. Message field of event record contains the embedded facet. Other fields of event record are as for mouse down. æKY kODEvtMouseUpEmbedded æC A mouse up event in an embedded facet. Sent to containing facet. Message field of event record contains the embedded facet. Other fields of event record are as for mouse up. æKY kODEvtMouseDownBorder æC Mouse down in the active border (around facets of the frame with the selection focus). Message field of event record contains the embedded facet. Other fields of event record are as for mouse down. æKY kODEvtMouseUpBorder æC Mouse up in the active border (around facets of the frame with the selection focus). Message field of event record contains the embedded facet. Other fields of event record are as for mouse up. æKY kODEvtWindow æC Adaptation of mouse event in the title bar of a window. Message field of event record contains part code returned by FindWindow(). Other fields of event record are as for mouse down. æKY kODEvtMouseEnter æC Sent when the mouse first enters a frame (mouse button up). The eventInfo parameter contains the mouse location in local (frame) coordinates. æKY kODEvtMouseWithin æC Sent when the mouse moves within a frame (mouse button up). The eventInfo parameter contains the mouse location in local (frame) coordinates. æKY kODEvtMouseLeave æC Sent when the mouse moves out of a frame (mouse button up). The eventInfo parameter contains the mouse location in local (frame) coordinates. æKY UI Subsystem - Command IDs Constants æKL kODCommandAbout kODCommandNew kODCommandOpen kODCommandOpenDocument kODCommandInsert kODCommandClose kODCommandSave kODCommandSaveACopy kODCommandRevert kODCommandDraft kODCommandPageSetup kODCommandPrint kODCommandUndo kODCommandRedo kODCommandCut kODCommandCopy kODCommandPaste kODCommandPasteAs kODCommandClear kODCommandSelectAll kODCommandGetPartInfo kODCommandPreferences kODCommandViewAsWin kODCommandDeleteDocument æC Position-independent command IDs for the menus in the base menu bar, as provided by the OpenDoc shell. æKY kODCommandAbout æC The command ID for the About… menu item in the Apple menu. æKY kODCommandNew æC The command ID for the New… item in the Document menu. æKY kODCommandOpen æC The command ID for the Open item in the Document menu. Applies to a selected frame. æKY kODCommandOpenDocument æC The command ID for the Open Document… item in the Document menu, which brings up the Standard File dialog. æKY kODCommandInsert æC The command ID for the Insert… item in the Document menu. æKY kODCommandClose æC The command ID for the Close item in the Document menu. æKY kODCommandSave æC The command ID for the Save menu item in the Document menu. æKY kODCommandSaveACopy æC The command ID for the Save a Copy… item in the Document menu. æKY kODCommandRevert æC The command ID for the Revert… item in the Document menu. æKY kODCommandDraft æC The command ID for the Drafts… item in the Document menu. æKY kODCommandPageSetup æC The command ID for the Page Setup… item in the Document menu. æKY kODCommandPrint æC The command ID for the Print… item in the Document menu. æKY kODCommandUndo æC The command ID for Undo item in the Edit menu. æKY kODCommandRedo æC The command ID for Redo item in the Edit menu. æKY kODCommandCut æC The command ID for Cut item in the Edit menu. æKY kODCommandCopy æC The command ID for Copy item in the Edit menu. æKY kODCommandPaste æC The command ID for Paste item in the Edit menu. æKY kODCommandPasteAs æC The command ID for the Paste As… item in the Edit menu. æKY kODCommandClear æC The command ID for Clear item in the Edit menu. æKY kODCommandSelectAll æC The command ID for the Select All item in the Edit menu. æKY kODCommandGetPartInfo æC The command ID for the Get Part Info item in the Edit menu. æKY kODCommandPreferences æC The command ID for the Preferences… item in the Edit menu. æKY kODCommandViewAsWin æC The command ID for the View As Window item in the Edit menu. æKY kODCommandDeleteDocument æC Command ID for the "Delete Document" command in the Document menu. æKY UI Subsystem - Foci Constants æKL kODScrollingFocus kODKeyFocus kODMenuFocus kODSelectionFocus kODModalFocus kODClipboardFocus æC Constants for the standard foci managed by the Arbitrator. These constants are ISO strings which can be tokenized using ODSession::Tokenize(). æKY kODScrollingFocus æC Of type ODFocusType. PageUp etc. keys are sent to the owner of the scrolling focus, which may be different from the keystroke focus. æKY kODKeyFocus æC Of type ODFocusType. The frame which owns this focus is the recipient of keyboard events. æKY kODMenuFocus æC Of type ODFocusType. The frame which owns this focus receives menu events. æKY kODSelectionFocus æC Of type ODFocusType. The active border is drawn around all facets of the frame with the selection focus. Modified mouse clicks are sent to this frame. æKY kODModalFocus æC Of type ODFocusType. A frame in a modal state should own the modal focus. æKY kODClipboardFocus æC Of type ODFocusType. The frame which owns this focus has access to the clipboard. æKY UI Subsystem - Menu IDs Constants æKL kODAppleMenuID kODFileMenuID kODEditMenuID æC The IDs of the menus in the base menu bar installed by the shell. æKY kODAppleMenuID æC The ID of the Apple Menu. æKY kODFileMenuID æC The ID of the Document menu. æKY kODEditMenuID æC The ID of the Edit Menu. æKY UI Subsystem - Part Codes Constants æKL kODMDInDesk kODMDInMenuBar kODMDInSysWindow kODMDInContent kODMDInDrag kODMDInGrow kODMDInGoAway kODMDInZoomIn kODMDInZoomOut æC These map exactly to the part codes as returned by FindWindow(). See Inside Mac. æKY kODMDInDesk æC æKY kODMDInMenuBar æC æKY kODMDInSysWindow æC æKY kODMDInContent æC æKY kODMDInDrag æC æKY kODMDInGrow æC æKY kODMDInGoAway æC æKY kODMDInZoomIn æC æKY kODMDInZoomOut æC æKY UI Subsystem-Persistent Properties Constants æKL kODPropRootFrameList kODPropWindowProperties kODPropWindowRect kODPropWindowTitle kODPropWindowProcID kODPropWindowIsVisible kODPropWindowHasCloseBox kODPropWindowHasZoomBox kODPropWindowIsResizable kODPropWindowIsRootWindow kODPropWindowIsFloating kODPropWindowHasMailer kODPropWindowIsMailerAware kODPropWindowRefCon kODPropRootFrame kODPropSourceFrame kODPropShouldShowLinks æC Constants for the persistent properties of UI system object, namely ODWindows. æKY kODPropRootFrameList æC = "OpenDoc:Property:RootFrameList". A property of the draft. A list of storage unit IDs for the root frames of saved windows. æKY kODPropWindowProperties æC = "OpenDoc:Property:Window". A reference to a storage unit containing window size etc. Added to the root frame of saved windows. æKY kODPropWindowRect æC = "OpenDoc:Property:WindowRect". Value type kODRect. The bounding rectangle of a window. æKY kODPropWindowTitle æC = "OpenDoc:Property:WindowTitle". Value type kODAppleTEXT. Stores the title of the window. æKY kODPropWindowProcID æC = "OpenDoc:Property:WindowProcID". Stores the ProcID of the window. Value type kODSShort. æKY kODPropWindowIsVisible æC = "OpenDoc:Property:WindowVisible". Stores whether the window is visible or not. Value type kODBoolean. æKY kODPropWindowHasCloseBox æC = "OpenDoc:Property:WindowHasCloseBox". Stores whether the window has a close box or not. Value type kODBoolean. æKY kODPropWindowHasZoomBox æC = "OpenDoc:Property:WindowHasZoomBox". Stores whether the window has a zoom box or not. Value type kODBoolean. æKY kODPropWindowIsResizable æC = "OpenDoc:Property:WindowIsResizable". Stores whether the window has a resize box or not. Value type kODBoolean. æKY kODPropWindowIsRootWindow æC = "OpenDoc:Property:WindowIsRootWindow". Stores whether the window is visible or not. Value type kODBoolean. æKY kODPropWindowIsFloating æC = "OpenDoc:Property:WindowIsFloating". Stores whether the window is floating or not. Value type kODBoolean. æKY kODPropWindowHasMailer æC = "OpenDoc:Property:WindowHasMailer". Stores whether the window has a mailer attached or not. Value type kODBoolean. æKY kODPropWindowIsMailerAware æC = "OpenDoc:Property:WindowIsMailerAware". Stores whether the window can have a mailer attached or not. Value type kODBoolean. æKY kODPropWindowRefCon æC = "OpenDoc:Property:WindowRefCon". Stores the value of the refCon field of the window record. Value type kODSLong. æKY kODPropRootFrame æC = "OpenDoc:Property:RootFrame". Storesthe ID of the root frame. Value type kODID. æKY kODPropSourceFrame æC = "OpenDoc:Property:SourceFrame". Storesthe ID of the source frame. Value type kODID. æKY kODPropShouldShowLinks æC = "OpenDoc:Property:ShouldShowLinks". Stores whether or not parts in this window should display link borders. æKY UI subsytem - Undo Constants æKL kODDone kODUndone kODRedone æKY kODDone æC Value passed to Part::DisposeActionState() if the action was on the Undo stack æKY kODUndone æC Value passed to Part::DisposeActionState() if the action was on the Redo stack æKY kODRedone æC Value passed to Part::DisposeActionState() if the action was on the Undo stack æKY ODContainerHelp ODContainer Container æKL ODContainer::ODContainer ODContainer::~ODContainer ODContainer::Close ODContainer::Create ODContainer::GetDocument ODContainer::GetID ODContainer::GetName ODContainer::GetStorageSystem ODContainer::IncrementRefCount ODContainer::InitContainer ODContainer::Open ODContainer::Purge ODContainer::Release ODContainer::ReleaseDocument ODContainer::SetName ODContainer::fDocuments ODContainer::fID ODContainer::fName ODContainer::fStorageSystem æC Basic Class Documentation A Container is a physical collection of bytes, like a file or a section of memory. Each Container contains one or more Documents. Each Document in turn contains one or more Drafts. Each Draft in turn contains one or more ODStorageUnit. ODContainer is a class used to manipulate this physical Container. Similarly, ODDocument is a class used to manipulate a Document; ODDraft maniuplates a Draft; and ODStorageUnit manipulates a Storage Unit. This set of related ODContainer, ODDocument, ODDraft and ODStorageUnit classes are collectively called a Container Suite. They are usually implemented together as a set and work intimately with each other. The class documented here (ODContainer) is a abstract base class. Container Suite Implementors should subclass ODContainer to provide the functionality of a OpenDoc Container for their Container Suite. Theory of Operation ODContainer is derived from ODRefCntObject. When ODContainer is first constructed (either through ODAbsStorageSystem::CreateContainer or ODAbsStorageSystem::GetContainer), its reference count is 1. Every time ODAbsStorageSystem::GetContainer is called with containerType and id referring to this Container, the refCount of the corresponding ODContainer object is incremented by 1. When ODContainer is no longer needed, ODContainer::Release should be called. This class is never directly instantiated by anyone except the Storage System. When the Shell or a Container App needs to create or get an OpenDoc container, it will call the corresponding ODStorageSystem method. The ODStorageSystem method will then instantiate a ODContainer object to manipuate the physical Container. Invariants Maintained by Class There is at most one (i.e. 0 or 1) ODDocument object for every ODDocumentID requested via GetDocument. Until a requested document has been Released, the ODDocument object will be valid. After a requested document has been Released, the ODDocument object which referred to that document is no longer valid. It is the responsibility of ODContainer to maintain these invariants, not ODDocument, since ODContainer maintains the collection of ODDocuments. æKY ODContainer::ODContainer Container::ODContainer Container->ODContainer æT Class Method æD ODContainer(); æC Protection Public. Private by convention. This method is only called by ODStorageSystem. Override policy Derived class must override. Derived class must call base class behavior. Basic operation Constructor of the class. Inputs None. Outputs <return> a valid ODContainer object Exceptions Signalled None. Pre conditions None. Post conditions An un-Initialized ODContainer object is created. æKY ODContainer::~ODContainer Container::~ODContainer Container->~ODContainer æT Class Method æD ~ODContainer(); æC Protection Public. Private by convention. This method is only called by ODStorageSystem. Override policy Derived class must override. Derived class must call base class behavior. Basic operation Deletes its ODDocument object (if exists), and closes the container. Inputs none Outputs none Exceptions Signalled None. Pre conditions this is a valid ODContainer object. Post conditions The container associcated with this ODContainer object is closed. this is no longer a valid ODContainer object. æKY ODContainer::Close Container::Close Container->Close æT Class Method æD ODContainer* Close(); æC Protection Public. Private by convention. This method should only be called by ODStorageSystem::ReleaseContainer. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Closes an access session to the container associated with this ODContainer object. Inputs none Outputs <return> this Exceptions Signalled None. Pre conditions There is an open access session to the container associated with this ODContainer object Post conditions There is no access session to the container associated with this ODContainer object æKY ODContainer::Create Container::Create Container->Create æT Class Method æD ODContainer* Create(); æC Protection Public. Private by convention. This method should only be called by ODStorageSystem::CreateContainer. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Creates the physical Container using this ODContainer object and associates the created container with this ODContainer object. This function does NOT open the container. Inputs none Outputs <return> this Exceptions Signalled kODErrCannotCreateContainer Cannot create the physical Container. Pre conditions None. Post conditions There exists a physical Container which conforms to the specification contained in this ODContainer object. æKY ODContainer::GetDocument Container::GetDocument Container->GetDocument æT Class Method æD ODDocument* GetDocument( ODDocumentID id); æC Protection Public. The Shell calls this method when a OpenDoc Document is opened. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns a fully functional ODDocument object associated with the given id. (A fully functional object is one that has been initialized and can be used right away). Inputs id ID of the document reqeusted Outputs <return> A fully functional ODDocument object. Exceptions Signalled kODErrInvalidDocument Cannot get desired Document because the id is invalid. Pre conditions None. Post conditions The refCount of ODDocument object is incremented by 1 if ODDocument object is in the ODDocument collection prior to this call. Otherwise, the refCount of ODDocument object should be 1. æKY ODContainer::GetID Container::GetID Container->GetID æT Class Method æD ODContainerID GetID(); æC Protection Public. A Part should not need to worry about the ID of its container. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns the ID of this object. This ID should be the one used in ODAbsStorageSystem::CreateContainer or ODAbsStorageSystem::CreateContainer. Inputs none Outputs <return> ID of the Container. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODContainer::GetName Container::GetName Container->GetName æT Class Method æD ODContainerName GetName(); æC Protection Public. A Part can call this method but it should not need to know its Container's name. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns a copy of the name of this container. If the Container does not have a name, kODNULL is returned. Inputs none Outputs <return> Name of the container. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODContainer::GetStorageSystem Container::GetStorageSystem Container->GetStorageSystem æT Class Method æD ODStorageSystem* GetStorageSystem(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns the ODStorageSystem object associated with this ODContainer object. Inputs none Outputs <return> ODStorageSystem object associated with this ODContainer Object. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODContainer::IncrementRefCount Container::IncrementRefCount Container->IncrementRefCount æT Class Method æD void IncrementRefCount(); æC Protection Public. Can be called by any class which needs a reference to this ODContainer object. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Increments the reference count of the Container. Inputs none Outputs None Exceptions Signalled None. Pre conditions None. Post conditions The reference count for this object is incremented by 1. æKY ODContainer::InitContainer Container::InitContainer Container->InitContainer æT Class Method æD void InitContainer(); æC Protection Public. Private by convention. This method should only be called by ODStorageSystem::CreateContainer or ODStorageSystem::GetContainer. Override policy Derived class must override. Derived class must call base class behavior. Basic operation Initializes this ODContainer object. Inputs none Outputs none Exceptions Signalled None. Pre conditions None. Post conditions this ODContainer object has been properly initialized. æKY ODContainer::Open Container::Open Container->Open æT Class Method æD ODContainer* Open(); æC Protection Public. Private by convention. This method should only be called by ODStorageSystem::CreateContainer and ODStorageSystem::GetContainer. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Opens an access session to the container associated with this ODContainer object. Inputs None Outputs <return> this Exceptions Signalled kODErrCannotOpenContainer Cannot open the physical Container. Pre conditions There is no access session to the container associated with this ODContainer object. Post conditions There is an open access session to the container associated with this ODContainer object. æKY ODContainer::Purge Container::Purge Container->Purge æT Class Method æD ODSize Purge( ODSize size); æC Protection Public. Private by convention. This method should only be called by ODStorageSystem::Purge. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Purges memory from ephemeral store until size bytes (not necessarily contiguous) have been freed up. Inputs size Number of bytes to purge Outputs <return> Number of bytes actually purged Exceptions Signalled None. Pre conditions None. Post conditions Either size bytes (not necessarily contiguous) are free in the default heap or Purge() has been called on every ODDocument object associated with this ODContainer object. æKY ODContainer::Release Container::Release Container->Release æT Class Method æD ODStorageSystem* Release(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Decrements the ref count of this ODContainer object. Inputs none Outputs <return> fStorage Exceptions Signalled None. Pre conditions None. Post conditions This ODContainer object is no longer guaranteed to be a valid ODContainer object æKY ODContainer::ReleaseDocument Container::ReleaseDocument Container->ReleaseDocument æT Class Method æD ODContainer* ReleaseDocument( ODDocument* document); æC Protection Public. Private by convention. This method should only be called by ODDocument::Release. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Releases the ODDocument object. Inputs document the document to be released Outputs <return> this ODContainer object. Exceptions Signalled None. Pre conditions document is a valid ODDocument object in this container which was obtained via GetDocument. The reference count of document is 0. Post conditions document is no longer a valid ODDocument object. æKY ODContainer::SetName Container::SetName Container->SetName æT Class Method æD void SetName( ODContainerName name); æC Protection Public. Called by the Shell or the Container App to set the name of this Container. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Sets the name of this container. Inputs name the new name of this container Outputs none Exceptions Signalled None. Pre conditions name is a valid ODContainerName Post conditions The name of the container is name. æKY ODContainer::fDocuments Container::fDocuments æT Class Field æD LinkedList* æC Persistent form None. æKY ODContainer::fID Container::fID æT Class Field æD ODContainerID æC Persistent form None. æKY ODContainer::fName Container::fName æT Class Field æD ODContainerName æC Persistent form Container Name kODPropCntainerName Contains the name of the container. æKY ODContainer::fStorageSystem Container::fStorageSystem æT Class Field æD ODStorageSystem* æC æKY ODCPlusSemanticInterfaceHelp ODCPlusSemanticInterface CPlusSemanticInterface æKL ODCPlusSemanticInterface::GetSIHelper ODCPlusSemanticInterface::InitCPlusSemanticInterface æC Basic Class Documentation This class is a supported subclass of the abstract base class ODSemanticInterface. It is C++ specific because it uses a C++ helper class to implement its functionality. All the functionality of this class is found in the helper class, SIHelperAbs. This class is an abstract base class. A supported subclass is provided called SIHelper. Please consult the documentation for this class. Theory of Operation This class simply overrides the unimplemented methods of the abstract base class ODSemanticInterface and forwards all the calls to the methods of the C++ helper class. Invariants Maintained by Class An instance of the C++ helper class must be valid and exist for the life of an instance of this class. æKY ODCPlusSemanticInterface::GetSIHelper CPlusSemanticInterface::GetSIHelper CPlusSemanticInterface->GetSIHelper æT Class Method æD æC Protection Public. Override policy Derived class can override. Derived class must call base class behavior, before derived class behavior. Basic operation Returns the subclass of SIHelperAbs being used by this instance of the class. Inputs None. Outputs <return> subclass of SIHelperAbs being used by this instance of the class. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODCPlusSemanticInterface::InitCPlusSemanticInterface CPlusSemanticInterface::InitCPlusSemanticInterface CPlusSemanticInterface->InitCPlusSemanticInterface æT Class Method æD æC Protection Public. Override policy Derived class can override. Derived class must call base class behavior, before derived class behavior. Basic operation This call initializes the instance and sets the part to base and the helper class to helper. Inputs base the part for which this is the SemanticInterface extension helper the subclass of the class SIHelperAbs to be used. session a reference to the instance of the ODSession. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODDescHelp ODDesc Desc æKL ODDesc::GetDescType ODDesc::GetRawData ODDesc::SetDescType ODDesc::SetRawData æC Basic Class Documentation This class is intended to imitate the functionality of the Apple event type AEDesc. The main difference is that ODDescs will be correctly marshalled in a DSOM world, whereas AEDescs cannot be. In release 1.0 of OpenDoc, this class has only four simple methods using to input and export data from the ODDesc. Therefore, in order to use an ODDesc, you must first extract the data from it, create an AEDesc from it and use the appropriate Apple event manager functions on it. two public utility routines are provided that make this process easier: AEDesctoODDesc, ODDescToAEDesc. Theory of Operation This class is intended to hide the implementation of an AEDesc from the user and therefore allow DSOM-ability and future changes. Platform implementors should do whatever is appropriate for their platform. Invariants Maintained by Class æKY ODDesc::GetDescType Desc::GetDescType Desc->GetDescType æT Class Method æD æC Protection Public. Override policy Derived class can override. Derived class must call base class behavior, during derived class behavior. Basic operation Return the descriptor type of the ODDesc. Note that if an ODDesc represents a Apple event-specific descriptor, this data may be meaningless to the user. However, when creating an AEDesc from this data, the appropriate Apple event manager functions can then be used on that AEDesc to interpret the data. Inputs None. Outputs <return> the descriptor type Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODDesc::GetRawData Desc::GetRawData Desc->GetRawData æT Class Method æD æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Return the ODByteArray that represents the raw data contained in the ODDesc. Note that if an ODDesc represents a Apple event-specific descriptor, this data may be meaningless to the user. However, when creating an AEDesc from this data, the appropriate Apple event manager functions can then be used on that AEDesc to interpret the data. Inputs None. Outputs <return> the raw bytes. Exceptions Signalled kODErrOutOfMemory Could not allocate the memory for the return parameter. Pre conditions None. Post conditions An new ODByteArray is allocated. æKY ODDesc::SetDescType Desc::SetDescType Desc->SetDescType æT Class Method æD æC Protection Public. Override policy Derived class can override. Derived class must call base class behavior, during derived class behavior. Basic operation Set the descriptor type of the ODDesc. Note that this may change the interpretation of the data in the descriptor, but will not change the raw data itself. Note that if an ODDesc represents a Apple event-specific descriptor, this data may be meaningless to the user. However, when creating an AEDesc from this data, the appropriate Apple event manager functions can then be used on that AEDesc to interpret the data. Inputs descType The descriptor type. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODDesc::SetRawData Desc::SetRawData Desc->SetRawData æT Class Method æD æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Set the raw data contained in the ODDesc using the ODByteArray that is passed in. Any previous data is deleted. Note that if an ODDesc represents a Apple event-specific descriptor, this data may be meaningless to the user. However, when creating an AEDesc from this data, the appropriate Apple event manager functions can then be used on that AEDesc to interpret the data. Inputs data The raw bytes. Outputs None. Exceptions Signalled kODErrOutOfMemory Could not allocate storage for the input parameter. Pre conditions None. Post conditions An new ODByteArray is allocated. æKY ODDispatcherHelp ODDispatcher Dispatcher æKL ODDispatcher::ODDispatcher ODDispatcher::~ODDispatcher ODDispatcher::AddDispatchModule ODDispatcher::AddMonitor ODDispatcher::Dispatch ODDispatcher::Exit ODDispatcher::GetDispatchModule ODDispatcher::GetMouseRegion ODDispatcher::GetSleepTime ODDispatcher::InitDispatcher ODDispatcher::InvalidateFacetUnderMouse ODDispatcher::Purge ODDispatcher::Redispatch ODDispatcher::RegisterIdle ODDispatcher::RemoveDispatchModule ODDispatcher::RemoveMonitor ODDispatcher::SetIdleFrequency ODDispatcher::SetMouseRegion ODDispatcher::ShouldExit ODDispatcher::UnregisterIdle ODDispatcher::Yield ODDispatcher::fExit ODDispatcher::fFacetUnderMouse ODDispatcher::fIdleList ODDispatcher::fMouseRegion ODDispatcher::fPartMouseRegion ODDispatcher::fSession æC Basic Class Documentation ODDispatcher defines an extensible event dispatcher for distributing events to parts. Each OpenDoc session has a single dispatcher object, accessed by calling ODSession::GetDispatcher(). The dispatcher is called from the application shell's event loop to dispatch events to parts. ODDispatcher is a derived class of ODObject. A related class is ODDispatchModule. ODDispatcher is implemented by platform vendors. It is platform-specific, since different platforms have different models for handling events. Theory of Operation The dispatcher is responsible for distributing events to parts. Events not handled by a part are handled by the shell application or dropped on the floor. The actual distribution of events is performed by dispatch modules. The dispatcher maintains a dictionary associating event codes with ODDispatchModule objects. One or more dispatch modules will handle standard events, but part handlers can add ODDispatchModules for new event types. A dispatch module can also be installed as a monitor. In this case, it gets to see events of a certain type, but does not “swallow them up”. No assumptions can be made regarding the order in which events are monitored and handled. Events are passed to parts using a single bottleneck method ODPart::HandleEvent(). Part Editors or a part editor framework must examine the event data to determine the type of event. Invariants Maintained by Class ODDispatcher maintains a dictionary of ODDispatchModule objects, indexed by event type. The dictionary contains at least one dispatch module for handling the standard events of a particular platform. ODDispatcher also contains a reference to the system interface, for easy access. Other Persistent Properties No persistent properties æKY ODDispatcher::ODDispatcher Dispatcher::ODDispatcher Dispatcher->ODDispatcher æT Class Method æD ODDispatcher(); æC Protection Public. The dispatcher is created by the OpenDoc session object. Parts do not create instances of this class. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Initializes the fields of the instance to safe defaults. Initialization that might fail is done in InitDispatcher(). Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions Dispatcher is constructed, but not yet usable, because InitDispatcher must be called. æKY ODDispatcher::~ODDispatcher Dispatcher::~ODDispatcher Dispatcher->~ODDispatcher æT Class Method æD ~ODDispatcher(); æC Protection Public. The dispatcher is destroyed by the OpenDoc session object. Parts do not destroy dispatchers. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Frees the memory allocated by the dispatcher. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions A valid instance. Post conditions The memory used by the instance is freed, and the instance is no longer usable. æKY ODDispatcher::AddDispatchModule Dispatcher::AddDispatchModule Dispatcher->AddDispatchModule æT Class Method æD void AddDispatchModule( ODEventType eventType, ODDispatchModule* dispatchModule); æC Protection Public. Not called by most parts. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Adds the specified dispatch module to the dictionary of dispatch modules. Inputs eventType An event code dispatchModule A dispatch module for that event Outputs None. Exceptions Signalled kODErrExistingDispatchModule module is already installed. kODErrInvalidDispatchModule specified dispatch module is invalid. Pre conditions A valid initialize instance. A valid initialized dispatch module. Post conditions The dictionary contains the specified dispatch module. æKY ODDispatcher::AddMonitor Dispatcher::AddMonitor Dispatcher->AddMonitor æT Class Method æD void AddMonitor( ODEventType eventType, ODDispatchModule* dispatchModule); æC Protection Public. Not called by most parts. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Adds the specified dispatch module as a monitor for the specified event type. Inputs eventType An event code dispatchModule A dispatch module for that event Outputs None Exceptions Signalled kODErrExistingDispatchModule module is already installed. kODErrInvalidDispatchModule specified dispatch module is invalid. Pre conditions A valid initialize instance. A valid initialized dispatch module. Post conditions The dictionary contains the specified dispatch module as a monitor. æKY ODDispatcher::Dispatch Dispatcher::Dispatch Dispatcher->Dispatch æT Class Method æD ODBoolean Dispatch( ODEventData event); æC Protection Public. Called by the OpenDoc shell application, or by container applications. May be called by Parts handling events in dialogs. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Dispatches the event to the appropriate part. Returns kODFalse if the event does not belong to any part, or if Part::HandleEvent returns kODFalse indicating that the event was not handled. Inputs event A platform-dependent event structure Outputs <return> kODTrue if the event was handled, kODFalse otherwise. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions Result contains kODTrue if any part handled the event, kODFalse otherwise. æKY ODDispatcher::Exit Dispatcher::Exit Dispatcher->Exit æT Class Method æD void Exit(); æC Protection Public. Can be called as a signal to the shell application to close down its process. Use with care. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Sets a Boolean flag in the dispatcher which the shell application can access using ShouldExit() Inputs None. Outputs None. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions fExit contains the value kODTrue. æKY ODDispatcher::GetDispatchModule Dispatcher::GetDispatchModule Dispatcher->GetDispatchModule æT Class Method æD ODDispatchModule GetDispatchModule( in ODEventType eventType); æC Protection Public. Not called by most parts, or by container apps or shells. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the dispatch module for the given event type. Will not be called by most parts, but might be called in order to "patch" dispatch modules by saving the existing one, and calling it from a new one. Inputs eventType An event code Outputs <return> The dispatch module for that event, or kODNULL Exceptions Signalled None. Pre conditions A valid initialize ODDispatcher instance. Post conditions The result contains the dispatch module, if any, for the specified event, or kODNULL if none has been installed. æKY ODDispatcher::GetMouseRegion Dispatcher::GetMouseRegion Dispatcher->GetMouseRegion æT Class Method æD ODRgnHandle GetMouseRegion(); æC Protection Public. Call by the shell or container apps. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the mouse region, which can be set by parts using GetMouseRegion(). The mouse region is recomputed if necessary, by calling Part::MouseEnter/MouseLeave/MouseWithin. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions Triggers a recomputation. æKY ODDispatcher::GetSleepTime Dispatcher::GetSleepTime Dispatcher->GetSleepTime æT Class Method æD ODSLong GetSleepTime(); æC Protection Public. Called by shells or container apps Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Computes an amount of time the shell can "sleep" before it needs to wake up to give idle time to registered frames. Called by the shell. The value is passed to WaitNextEvent. Inputs None. Outputs <return> The computed sleep time Exceptions Signalled None. Pre conditions A valid initialize ODDispatcher instance. Post conditions The result contains the computed sleep time. æKY ODDispatcher::InitDispatcher Dispatcher::InitDispatcher Dispatcher->InitDispatcher æT Class Method æD void InitDispatcher( ODSession* session); æC Protection Public. The dispatcher is created by the OpenDoc session object. Parts do not create dispatchers. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Performs initialization that could fail. Must be called before other methods of this object are called. Inputs session The OpenDoc session object Outputs None. Exceptions Signalled kODErrOutOfMemory Out of memory Pre conditions None. Post conditions An initialize, usable dispatcher. æKY ODDispatcher::InvalidateFacetUnderMouse Dispatcher::InvalidateFacetUnderMouse Dispatcher->InvalidateFacetUnderMouse æT Class Method æD void InvalidateFacetUnderMouse(); æC Protection Public. Called by Imaging subsystem when a facet is removed. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Sets the dispatcher's cache of the facet under the mouse to kODNULL. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions fFacetUnderMouse is kODNULL. æKY ODDispatcher::Purge Dispatcher::Purge Dispatcher->Purge æT Class Method æD ODSize Purge( ODSize size); æC Protection Public. Called by OpenDoc. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Tries to free up some memory, usually by flushing internal state to external storage. Inputs size The amount of memory requested. Outputs <return> The amount of memory freed. Exceptions Signalled None. Pre conditions A valid initialized instance Post conditions Some memory has been freed up. æKY ODDispatcher::Redispatch Dispatcher::Redispatch Dispatcher->Redispatch æT Class Method æD ODBoolean Redispatch( inout ODEventData event, inoutODEventInfo eventInfo); æC Protection Public. Called by dispatch modules when they tranlate an event. For example, when the standard dispatch module transoforms a mouse down in the menu bar to a menu event. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Dispatches the event to the appropriate part. Returns kODFalse if the event does not belong to any part, or if Part::HandleEvent returns kODFalse indicating that the event was not handled. Inputs event A platform-dependent event structure eventInfo Additional event information required for some events. See ODEventInfo. Outputs <return> kODTrue if the event was handled, kODFalse otherwise. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions Result contains kODTrue if any part handled the event, kODFalse otherwise. æKY ODDispatcher::RegisterIdle Dispatcher::RegisterIdle Dispatcher->RegisterIdle æT Class Method æD void RegisterIdle( ODPart* part, ODFrame* frame, ODIdleFrequency frequency); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Registers the specified frame for idle time. The frame can be kODNULL, in which case the part as a whole gets idle time. Inputs frame A frame which should receive idle messages. frequency How often to send idle messages. part The part which is interested in idle time Outputs None. Exceptions Signalled kODErrInvalidFrame The specified frame is invalid Pre conditions A valid initialized instance. Post conditions The dispatcher contains the part/frame in its idle list. æKY ODDispatcher::RemoveDispatchModule Dispatcher::RemoveDispatchModule Dispatcher->RemoveDispatchModule æT Class Method æD void RemoveDispatchModule( ODEventType eventType); æC Protection Public. Not called by most parts. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Removes the dispatch module for the specified event from the dictionary. Inputs eventType an event type Outputs None. Exceptions Signalled None. Pre conditions A dispatch module is installed for the specified event type. Post conditions The specified event type no longer has its associated dispatch module. æKY ODDispatcher::RemoveMonitor Dispatcher::RemoveMonitor Dispatcher->RemoveMonitor æT Class Method æD void RemoveMonitor( ODEventType eventType, ODDispatchModule* dispatchModule); æC Protection Public. Not called by most parts. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Removes the specified monitor for the specified event from the dictionary. Inputs eventType an event code dispatchModule A dispatchmodule which monitors the event type Outputs None. Exceptions Signalled None. Pre conditions The dispatch module is installed as a monitor for the specified event type. Post conditions The dispatch module is no longer a monitor for the specified event type. æKY ODDispatcher::SetIdleFrequency Dispatcher::SetIdleFrequency Dispatcher->SetIdleFrequency æT Class Method æD void SetIdleFrequency( in ODPart part, in ODFrame frame, in ODIdleFrequency frequency); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Sets the idle frequency of the specified part or part/frame. The idle frequency is usually specified when the frame/part is registered for idle time, but this method can be used to adjust it later. Inputs frame A frame which should receive idle messages (null events). Can be kODNULL. part The part which should receive null (idle) events frequency A new idle frequency, in ticks (60ths of a second) Outputs None. Exceptions Signalled None. Pre conditions A valid initialized dispatcher instance. Post conditions The part or part/frame pair now idles at a different frequency æKY ODDispatcher::SetMouseRegion Dispatcher::SetMouseRegion Dispatcher->SetMouseRegion æT Class Method æD void SetMouseRegion( ODRgnHandle area); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Sets the mouse region, which can be queried by the shell application using GetMouseRegion(). Inputs area the new mouse region Outputs None. Exceptions Signalled None. Pre conditions A valid shape. Post conditions Stored value is updated. æKY ODDispatcher::ShouldExit Dispatcher::ShouldExit Dispatcher->ShouldExit æT Class Method æD ODBoolean ShouldExit(); æC Protection Public. Generally called by the OpenDoc shell application to see if the dispatcher recommends the event loop be terminated. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns a Boolean value indicating whether the OpenDoc shell application should terminate. Inputs None. Outputs <return> The value of fTerminateEventLoop Exceptions Signalled None. Pre conditions A valid and initialized instance. Post conditions Result contains the value of fExit. æKY ODDispatcher::UnregisterIdle Dispatcher::UnregisterIdle Dispatcher->UnregisterIdle æT Class Method æD void UnregisterIdleFrame( ODPart* part, ODFrame* frame); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Removes the specified part/frame from the collection of parts interested in receiving idle messages. Inputs frame A frame which should no longer receive idle messages. part The part which was receiving idle events Outputs None. Exceptions Signalled kODErrInvalidFrame The specified frame is invalid Pre conditions A valid initialized instance. Post conditions The dispatcher does not contain the part/frame in its idle list. æKY ODDispatcher::Yield Dispatcher::Yield Dispatcher->Yield æT Class Method æD void Yield( ODFrame* frame); æC Protection Public. Called by parts during a long-running operation. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Gives processor time to other parts. Inputs frame The frame which is yielding Outputs None. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions No effect on internal state. æKY ODDispatcher::fExit Dispatcher::fExit æT Class Field æD ODBoolean fExit; æC æKY ODDispatcher::fFacetUnderMouse Dispatcher::fFacetUnderMouse æT Class Field æD ODFacet* fFacetUnderMouse; æC æKY ODDispatcher::fIdleList Dispatcher::fIdleList æT Class Field æD IdleList* fIdleList; æC æKY ODDispatcher::fMouseRegion Dispatcher::fMouseRegion æT Class Field æD RgnHandle fMouseRegion; æC æKY ODDispatcher::fPartMouseRegion Dispatcher::fPartMouseRegion æT Class Field æD RgnHandle fMouseRegion; æC æKY ODDispatcher::fSession Dispatcher::fSession æT Class Field æD ODSession* fSession æC æKY ODDispatchModuleHelp ODDispatchModule DispatchModule æKL ODDispatchModule::ODDispatchModule ODDispatchModule::~ODDispatchModule ODDispatchModule::Dispatch ODDispatchModule::InitDispatchModule ODDispatchModule::fSession æC Basic Class Documentation ODDispatchModule is an abstract class. The dispatcher can be extended by adding subclasses of ODDispatchModule. Related classes are ODDispatcher and ODStandardDispatchModule, which is private to part developers. ODDispatchModule has no base class. Theory of Operation See ODDispatcher Invariants Maintained by Class The field fSession points to the global system interface. æKY ODDispatchModule::ODDispatchModule DispatchModule::ODDispatchModule DispatchModule->ODDispatchModule æT Class Method æD ODDispatchModule(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Constructs a dispatch module. InitDispatchModule must be called. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions A constructed dispatch module. Not yet usable - InitDispatchModule must be called. æKY ODDispatchModule::~ODDispatchModule DispatchModule::~ODDispatchModule DispatchModule->~ODDispatchModule æT Class Method æD ~ODDispatchModule(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Frees the memory allocated by this object Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions It's gone. æKY ODDispatchModule::Dispatch DispatchModule::Dispatch DispatchModule->Dispatch æT Class Method æD ODBoolean Dispatch( inout ODEventData event, inout ODEventInfo eventInfo); æC Protection Public. Called by the dispatcher after it has located this module in its table. Override policy Derived class must override. Derived class can call base class behavior, during derived class behavior. Basic operation Classifies the event and dispatches it to the appropriate part. Inputs event A platform-specific event data structure eventInfo Additional information required by some events. Includes an ODPoint in local coordinates, and an embedded frame and facet. See ODEventInfo. Outputs <return> kODTrue if the event was handled by a part, kODFalse otherwise. Exceptions Signalled None. Pre conditions A valid event. Post conditions The event is dispatched. æKY ODDispatchModule::InitDispatchModule DispatchModule::InitDispatchModule DispatchModule->InitDispatchModule æT Class Method æD void InitDispatchModule( ODSession* session); æC Protection Public. Called only by concrete derived class's Init method. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Saves the session reference Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions Instance is usable. æKY ODDispatchModule::fSession DispatchModule::fSession æT Class Field æD ODSession* fSession; æC æKY ODDocumentHelp ODDocument Document æKL ODDocument::ODDocument ODDocument::~ODDocument ODDocument::CollapseDrafts ODDocument::CreateDraft ODDocument::Exists ODDocument::GetBaseDraft ODDocument::GetContainer ODDocument::GetDocumentProperties ODDocument::GetDraft ODDocument::GetID ODDocument::GetName ODDocument::IncrementRefCount ODDocument::InitDocument ODDocument::Purge ODDocument::Release ODDocument::ReleaseDraft ODDocument::SaveToAPrevDraft ODDocument::SetBaseDraftFromForeignDraft ODDocument::SetName ODDocument::fContainer ODDocument::fDrafts ODDocument::fID æC Basic Class Documentation A Container contains one or more Document. Each Document has a unique ODDocumentID within a Container. Each of these Docment contains one or more Draft. Each of these Drafts corresponds to a version of the Document. In other words, a Document is a collection of versioned Drafts. A ODDocument object is used to manipulate a Document and its Drafts. The class documented here is a abstract base class. Container Suite implementors should subclass this class to provide the functionality of a OpenDoc Document for their Container Suite. (For definition of Container Suite, please refer to documentation on ODContainer). Every OpenDoc Document by default has a base Draft. Theory of Operation ODDocument is derived from ODRefCntObject. A ODDocument object is instantiated when GetDocument of its corresponding ODContainer. When ODDocument is first constructed, its refCount is 1. Every time ODContainer::GetDocument is called using the same id, the refCount of the ODDocument object is incremented by 1. When ODDocument object is no longer needed, ODDocument::Release should be called. The ODDocument object is responsible for guaranteeing that there is only one ODDraft object associated with each Draft within it. ODDocument is only instantiated by ODContainer of the same Container Suite. If the Shell or the Container App wants to create or get a Document, it has to call ODContainer::GetDocument. Invariants Maintained by Class There is at most one ODDraft object for every ODDraftID requested via GetDraft or CreateDraft. Until a requested ODDraft has been Released, the ODDraft object will be valid. After a requested draft has been Released, the ODDraft object which referred to that draft is not guaranteed to be valid. It is the responsibility of ODDocument to maintain these invariants, not ODDraft, since ODDocument maintains the collection of ODDrafts. Other Persistent Properties A ODDocument must have a ODContainer object associated with it. Every Document (hence ODDocument object) within a Container must have a unique ODDocumentID. Every Document can have at most one name. Drafts are linearly derived in a Document. The top Draft is the only Draft that can be modified. All the Drafts below the top Draft are read-only. æKY ODDocument::ODDocument Document::ODDocument Document->ODDocument æT Class Method æD ODDocument(); æC Protection Public. Private within Storage Subsystem. This method should only be called by ODContainer::GetDocument. Override policy Derived class can override. Derived class must call base class behavior, before derived class behavior. Basic operation Creates an uninitialized ODDocument object. Inputs None. Outputs <return> A valid ODDocument object. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODDocument::~ODDocument Document::~ODDocument Document->~ODDocument æT Class Method æD ~ODDocument(); æC Protection Public. Private within Storage Subsystem. This method should only be called by ODContainer::ReleaseDocument. Override policy Derived class can override. Derived class must call base class behavior, before derived class behavior. Basic operation This is the destructor of the ODDocument class object. It releases all the memory associated with this ODDocument class object. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions this is a valid ODDocument object. Post conditions this is no longer a valid ODDocument object. æKY ODDocument::CollapseDrafts Document::CollapseDrafts Document->CollapseDrafts æT Class Method æD ODDocument* CollapseDrafts( ODDraft* from, ODDraft* to); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior, after derived class behavior. Basic operation Removes all the drafts between from (inclusive) and to (exclusive). All the Drafts between from (inclusive) and to (exclusive) must be empty. This call is used for getting rid of unnecessary Drafts. Inputs from Draft to collapse from to Draft to collapse to Outputs <return> this ODDocument object Exceptions Signalled kODErrNonEmptyDraft Non-empty draft between from and to. kODErrCannotCollapseDrafts from is not above to. kODErrOutstandingDraft There is one or more outstanding Draft (i.e., refCount >= 1) between from and to. Pre conditions The drafts between from (inclusive) and to (exclusive) are 'empty'. There is no outstanding Draft (i.e., with refCount >= 1) between from (exclusive) and to (exclusive). from must have a refCount of 1. from must not be the base Draft. from must be above to in the Draft topology. Post conditions The drafts between from (inclusive) and to (exclusive) have been removed and the appropriate draft topology is maintained. from is no longer a valid ODDraft object. æKY ODDocument::CreateDraft Document::CreateDraft Document->CreateDraft æT Class Method æD ODDraft* CreateDraft( ODDraft* below, ODBoolean releaseBelow); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior, before derived class behavior. Basic operation Creates a new Draft on top of below and returns a ODDraft object referring to the created Draft. If releaseBelow is kODTrue, the below draft is released. If this container does not support creation of drafts (e.g. a read-only medium like a CD-ROM), an exception is raised. Inputs below The draft on which the new draft is to be created. releaseBelow Boolean to show whether or not the below draft should be released. Outputs <return> a fully functional ODDraft object with Exclusive-Write permissions. Exceptions Signalled kODErrInvalidContainer Container does not support creation of new drafts. kODErrInvalidBelowDraft below is kODNULL or below is not the Top Draft of the Document. kODErrInvalidPermissions Exclusive-Write-Only below is not released. Pre conditions below is the Top Draft of the Document. If below is Exclusive-Write-only, releaseBelow must be kODTrue. Post conditions None. æKY ODDocument::Exists Document::Exists Document->Exists æT Class Method æD ODBoolean Exists( in ODDraftID id, in ODDraft draft, in ODPositionCode posCode); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns kODTrue if the specified Draft exists. Otherwise, returns kODFalse. If id is not 0, it is used to identify the Draft and the draft and posCode parameters are ignored. If id is 0, draft and posCode are used to identify the desired draft. Inputs id draft id draft ODDraft object used together with posCode to identify the desired Draft. posCode relative position (used together with draft) to identify the desired Draft. Outputs <return> a fully functional ODDraft object Exceptions Signalled kODInvalidPermissions Invalid permissions. kODErrInvalidRefCount draft does not have a valid refCount. kODErrCannotChangePermissions Cannot change permission on draft if it is gotten again with a different permissions. kODErrInvalidPosCode Invalid relative position. Pre conditions None. Post conditions None. æKY ODDocument::GetBaseDraft Document::GetBaseDraft Document->GetBaseDraft æT Class Method æD ODDraft* GetBaseDraft( ODDraftPermissions perms); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns an ODDraft object which refers to the base draft of the document with the given perms. Inputs perms permissions Outputs <return> ODDraft object which refers to the base draft of this document Exceptions Signalled kODErrInvalidPermissions Invalid permissions. Pre conditions perms can be Read-Only if the Draft has not been gotten for Exclusive -Write-only. perms can be Exclusive-Write-only if the Draft has not been gotten (i.e., there is no valid ODDraft object referring to the desired Draft) and the Base Draft is the top Draft in the Document. perms can be Shared-Write if the Draft has not been gotten for Read-Only or Exclusive-Write-Only and the Base Draft is the top Draft of the Document. Post conditions None. æKY ODDocument::GetContainer Document::GetContainer Document->GetContainer æT Class Method æD ODContainer* GetContainer(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns the ODContainer object with which this ODDocument object is associated. Inputs none Outputs <return> fContainer Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODDocument::GetDocumentProperties Document::GetDocumentProperties Document->GetDocumentProperties æT Class Method æD ODStorageUnit* GetDocumentProperties(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns a ODStorageUnit object where meta-information on this Document can be stored. Note that the client has to call ODStorageUnit::Release when the ODStorageUnit is not needed anymore. Inputs None. Outputs <return> ODStorageUnit object where meta-information on this Document is stored. Exceptions Signalled kODErrNoDocumentProperties Cannot create ODStorageUnit for Document Properties. Pre conditions None. Post conditions None. æKY ODDocument::GetDraft Document::GetDraft Document->GetDraft æT Class Method æD ODDraft* GetDraft( ODDraftPermissions perms, ODDraftID id, ODDraft* draft, ODPositionCode posCode, ODBoolean release); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior, during derived class behavior. Basic operation If id is not 0, it is used to identify the Draft and the draft and posCode parameters are ignored. If id is 0, draft and posCode are used to identify the desired draft. Once the draft is identified, a ODDraft object referring to the desired draft is created and returned with the given permissions. The release parameter is only used if draft and posCode are used to identify the Draft. In this case, if release is kODTrue, draft is released if the desired draft can be gotten. It is valid to get the same Draft using draft and kODPosSame. In this case, the Draft is gotten again with the appropriate permissions. This provides an easy way to change the permissions for a ODDraft. Inputs perms permissions id draft id draft ODDraft object used together with posCode to identify the desired Draft. posCode relative position (used together with draft) to identify the desired Draft. release ODBoolean to show whether draft should be released when getting the desired one. (Only used when relative positioning is done). Outputs <return> a fully functional ODDraft object Exceptions Signalled kODInvalidPermissions Invalid permissions. kODErrInvalidRefCount draft does not have a valid refCount. kODErrCannotChangePermissions Cannot change permission on draft if it is gotten again with a different permissions. kODErrInvalidPosCode Invalid relative position. Pre conditions Either id refers to a valid Draft in this Document or draft and posCode together refer to a valid Draft in this Document. perms can be Read-Only if the Draft has not been gotten for Exclusive -Write-only. perms can be Exclusive-Write-only if the Draft has not been gotten (i.e., there is no valid ODDraft object referring to the desired Draft) and the Draft is the top Draft of the Document. perms can be Shared-Write if the Draft has not been gotten for Read-Only or Exclusive-Write-Only and the Draft is the top Draft of the Document. Post conditions The specified draft, opened with the given perms is returned. If release is kODTrue and the draft is a valid ODDraft object referring to a draft in the same document, it should be released. æKY ODDocument::GetID Document::GetID Document->GetID æT Class Method æD ODDocumentID GetID(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns the ID of the document referred to by this ODDocument object. The returned ID should be the one used for getting this object in ODContainer::GetDocument. Inputs none Outputs <return> ID of the Document. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODDocument::GetName Document::GetName Document->GetName æT Class Method æD ODDocumentName* GetName(); æC Protection Public. A Part can call this method, but it should not need to deal with the name of the Document directly. Override policy Derived class must override. Derived class cannot call base class behavior, before derived class behavior. Basic operation Returns a copy of the name of this Document. If this Document does not have a name, kODNULL is returned. Inputs none Outputs <return> Name of the Document. kODNULL if the Document does not have any name. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODDocument::IncrementRefCount Document::IncrementRefCount Document->IncrementRefCount æT Class Method æD void IncrementRefCount(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Increments the reference count of this ODDocument object. Inputs none Outputs none Exceptions Signalled None. Pre conditions None. Post conditions Reference Count of this object is incremented by 1. æKY ODDocument::InitDocument Document::InitDocument Document->InitDocument æT Class Method æD void InitDocument( ODContainer* container, ODDocumentID id); æC Protection Public. Private within Storage Subsystem. This method should only be called by ODContainer::GetDocument. Override policy Derived class can override. Derived class must call base class behavior, before derived class behavior. Basic operation Initializes this ODDocument object. Inputs container ODContainer object with which this ODDocument is associated. id ID of the Document Outputs none Exceptions Signalled None. Pre conditions this is a valid ODDocument object. Post conditions this is an initialized ODDocument object. æKY ODDocument::Purge Document::Purge Document->Purge æT Class Method æD ODSize Purge( ODSize size); æC Protection Public. Private within Storage Subsystem. This method should only be called by ODContainer::Purge. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Purge memory from ephemeral store until size bytes (not necessarily contiguous) have been freed up. Inputs size the number of bytes to purge Outputs <return> the number of bytes actually purged Exceptions Signalled None. Pre conditions None. Post conditions Either size bytes (not necessarily contiguous) are free in the default heap or Purge() has been called on every ODDraft object associated with this ODDocument object. æKY ODDocument::Release Document::Release Document->Release æT Class Method æD void Release(); æC Protection Public. Override policy Derived class must override. Derived class must call base class behavior, after derived class behavior. Basic operation Releases this ODDocument object. If the reference count of this ODDocument goes down to zero, this method should notify its ODContainer object by calling ODContainer::ReleaseDocument. Inputs none Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions this document is no longer guaranteed to be a valid ODDocument object æKY ODDocument::ReleaseDraft Document::ReleaseDraft Document->ReleaseDraft æT Class Method æD ODDocument* ReleaseDraft( ODDraft* draft); æC Protection Public. Private within Storage Subsystem. This method should only be called by ODDraft::Release. Override policy Derived class must override. Derived class cannot call base class behavior, after derived class behavior. Basic operation Releases the given ODDraft object. Inputs draft the draft to be released Outputs <return> this ODDocument object. Exceptions Signalled None. Pre conditions draft has a refCount of 0. Post conditions None. æKY ODDocument::SaveToAPrevDraft Document::SaveToAPrevDraft Document->SaveToAPrevDraft æT Class Method æD void SaveToAPrevDraft( ODDraft* from, ODDraft* to); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Moves changes from the from draft to the to draft. If to is kODNULL, the changes are saved to the draft immediately below from. All the Drafts from from (inclusive) to to Draft (exclusive) are empty after this operation. This method can be used together with CollapseDrafts to get rid of unwanted Drafts. Inputs from draft to move changes from to draft to move changes to Outputs none Exceptions Signalled kODErrInvalidDraft from is not above to. kODErrOutstandingDraft There is one or more outstanding Draft between from (exclusive) and to (exclusive). Pre conditions from Draft is above to Draft. There is no outstanding Draft (i.e., refCount >= 1) between from (exclusive) and to (exclusive). Post conditions The Drafts from from (inclusive) to to (exclusive) have had all their 'changes' removed and all such changes have been incorporated into the to Draft. In other words, the Drafts from from (inclusive) to to (exclusive) are 'empty'. æKY ODDocument::SetBaseDraftFromForeignDraft Document::SetBaseDraftFromForeignDraft Document->SetBaseDraftFromForeignDraft æT Class Method æD void SetBaseDraftFromForeignDraft( ODDraft* draft); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Takes a version from one Document and copies its content to set up a new Document. Inputs draft draft to copy to base Outputs None. Exceptions Signalled None. Pre conditions draft is not from the same Document. This Document is a newly created Document with only an empty Base Draft. Post conditions This Document's Base Draft contains the same data as draft. æKY ODDocument::SetName Document::SetName Document->SetName æT Class Method æD void SetName( ODDocumentName name); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior, after derived class behavior. Basic operation Sets the name of this document. Inputs name New name of this Document Outputs none Exceptions Signalled None. Pre conditions name is a valid ODDocumentName. Post conditions The name of the document is name. æKY ODDocument::fContainer Document::fContainer æT Class Field æD ODContainer* æC Persistent form None. æKY ODDocument::fDrafts Document::fDrafts æT Class Field æD ODDraftList* æC Persistent form None. æKY ODDocument::fID Document::fID æT Class Field æD ODDocumentID æC æKY ODDraftHelp ODDraft Draft æKL ODDraft::ODDraft ODDraft::~ODDraft ODDraft::AbortClone ODDraft::BeginClone ODDraft::ChangedFromPrev ODDraft::Clone ODDraft::CreateFrame ODDraft::CreateLinkSource ODDraft::CreateLinkSpec ODDraft::CreatePart ODDraft::CreateStorageUnit ODDraft::EndClone ODDraft::Externalize ODDraft::GetDocument ODDraft::GetDraftProperties ODDraft::GetFrame ODDraft::GetID ODDraft::GetLink ODDraft::GetLinkSource ODDraft::GetName ODDraft::GetPart ODDraft::GetPermissions ODDraft::GetPersistentObject ODDraft::GetPersistentObjectID ODDraft::GetStorageUnit ODDraft::IncrementRefCount ODDraft::InitDraft ODDraft::IsValidID ODDraft::Purge ODDraft::Release ODDraft::ReleaseFrame ODDraft::ReleaseLink ODDraft::ReleasePart ODDraft::ReleaseStorageUnit ODDraft::RemoveChanges ODDraft::RemoveFrame ODDraft::RemoveFromDocument ODDraft::RemoveLink ODDraft::RemoveLinkSource ODDraft::RemovePart ODDraft::RemoveStorageUnit ODDraft::SaveToAPrevious ODDraft::SetChangedFromPrev ODDraft::SetName ODDraft::WeakClone ODDraft::fDocument ODDraft::fFrames ODDraft::fID ODDraft::fLinks ODDraft::fName ODDraft::fParts ODDraft::fPermissions ODDraft::fStorageUnits æC Basic Class Documentation An OpenDoc Draft contains information pertaining to a particular version of an OpenDoc Document. ODDraft objects are instantiated by calling GetDraft or CreateDraft of their ODDocument object. The class documented here is a abstract base class. Container Suite implementors should subclass this class to provide the functionality of a OpenDoc Document for their Container Suite. (For definition of Container Suite, please refer to documentation on ODContainer). Draft Properties: o handler preferences (for workgroups) (type or category, handler)* o mod date dateType o create date dateType o user last modified by usernametype/TEXTstringtype o comments Part? o mailerInfo whater AOCE says o memory high water mark long o has been 'Save'd by user boolean Theory of Operation This class is derived from ODRefCntObject. A ODDraft object is instantiated when CreateDraft or GetDraft is called on its corresponding ODDocument. When ODDraft is first constructed, its refCount is 1. Every time ODDocument::GetDraft is called on the same Draft, the refCount of the ODDraft object is incremented by 1. When ODDraft object is no longer needed, ODDraft::Release should be called. The ODDraft object is responsible for guaranteeing that there is only one ODStorageUnit object associated with each Storage Unit or persistent object within it. Access is guaranteed to be exclusive if the Draft has just been created (through CreateDraft) or if kDPExclusiveWrite permissions have been requested and granted on GetDraft. Access is not guaranteed to be exclusive if the Draft has been 'gotten' with any other permissions. ODDraft is only instantiated by ODDocument of the same Container Suite. If the Shell wants to create or get a Draft, it should call ODDocument::CreateDraft or ODDoucment::GetDraft. If the Base Draft is needed, ODDocument::GetBaseDraft should be called. Invariants Maintained by Class There is at most one ODPersistentObject (or its derived object) for every persistent object requested via Get/Create Part/Frame/Link. Until a requested persistent object has been Released, the persistent object will remain valid. After a requested ODPersistentObject has been Released, the ODPersistentObject is no longer valid. It is the responsibility of ODDraft to maintain these invariants, not the ODPersistentObjects or (their derived objects), since ODDraft maintains the collection of first class persistent objects. There can only be one Clone (initiated by BeginClone and terminated by AbortClone or EndClone) at a time. A Draft can have at most one name. æKY ODDraft::ODDraft Draft::ODDraft Draft->ODDraft æT Class Method æD ODDraft(); æC Protection Public. Private within Storage System. This method should only be called by ODDocument::CreateDraft or ODDocument::GetDraft. Override policy Derived class must override. Derived class must call base class behavior. Basic operation This function is the constructor of the class. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODDraft::~ODDraft Draft::~ODDraft Draft->~ODDraft æT Class Method æD ~ODDraft(); æC Protection Public. Private within Container Suite. This method should only be called by ODDocument::ReleaseDraft. Override policy Derived class must override. Derived class must call base class behavior. Basic operation This function is the destructor of the class. Inputs none Outputs none Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODDraft::AbortClone Draft::AbortClone Draft->AbortClone æT Class Method æD void AbortClone( ODDraftKey key); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Aborts the transacton started by BeginClone. When this method returns, none of the ODStorageUnits in the source ODDraft should be copied to the destination Draft. Inputs key ODDraftKey which identifies the transaction. Outputs None. Exceptions Signalled kODErrInvalidDraftKey Invalid Clone. Pre conditions None. Post conditions None. æKY ODDraft::BeginClone Draft::BeginClone Draft->BeginClone æT Class Method æD ODDraftKey BeginClone( ODDraft* destDraft, ODFrame* destFrame, ODCloneKind kind); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Begins a transaction on a data transfer between one ODDraft to another. Any ODStorageUnit::CloneTo called between BeginClone and EndClone is considered part of the transaction. The returned ODDraftKey is used for CloneTo, EndClone and AbortClone to ensure thread safety. Inputs kind The kind of clone operation being performed. destDraft The draft being cloned into. destFrame The frame being cloned into. This parameter may be kODNULL if the kind is not kODClonePaste or kODCloneDropMove. Outputs <return> Key to ensure thread safety. Exceptions Signalled kODErrCloningInProgress Another Clone has started already. Pre conditions None. Post conditions None. æKY ODDraft::ChangedFromPrev Draft::ChangedFromPrev Draft->ChangedFromPrev æT Class Method æD ODBoolean ChangedFromPrev(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Indicate whether or not this Draft is 'empty', i.e. has any changes been made between this Draft and the Draft immediately below this Draft. Inputs none Outputs <return> whether or not this Draft contains any changes from previous Draft Exceptions Signalled kODInvalidDraft Invalid Draft. Pre conditions this ODDraft object does not refere to the base draft of the document. Post conditions None. æKY ODDraft::Clone Draft::Clone Draft->Clone æT Class Method æD ODID Clone( in ODDraftKey key, in ODID fromObjectID, in ODID toObjectID, in ODID scope); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation This method clones a persistent object or a storage unit with the corresponding id. If toObjectID is specified, the Properties and Values will be copied to the Storage Unit/Persistent Object with the specified ID. If toObjectID is 0, a new Storage Unit is created in the destination Draft. Either way, the ID of the duplicated persistent object or storage unit is returned. Inputs fromObjectID ID of the persistent object or storage unit to be cloned. scope The scope of the clone (usually refer to the frame in which the persistent object or storage unit is contained). toObjectID ID of the duplicated persistent object or storage unit. key key of the current cloning transaction Outputs <return> ID of the duplicated persistent object or storage unit Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODDraft::CreateFrame Draft::CreateFrame Draft->CreateFrame æT Class Method æD ODFrame* CreateFrame( ODType frameType, ODFrame* containingFrame, ODShape* frameShape, ODCanvas* biasCanvas, ODPart* part, ODBoolean isOverlaid); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Constructs an appropriate frame object (according to the type) associated with it, and returns the ODFrame object. Inputs containingFrame see ODFrame documentaiont frameShape part isOverlaid frameType Type of the frame. biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs <return> new ODFrame object Exceptions Signalled kODErrCannotCreateFrame Cannot create ODFrame object. Pre conditions Exclusive-write or Shared-write permissions on this Draft. Post conditions This Draft is marked dirty. æKY ODDraft::CreateLinkSource Draft::CreateLinkSource Draft->CreateLinkSource æT Class Method æD ODLinkSource* CreateLinkSource( ODPart* part); æC Protection Public. Called by parts when creating the source of a link, typically in their CreateLink method. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Create a new ODLinkSource object in this draft. Since all ODLinkSource objects have a unique companion ODLink object, this method fails if the companion object cannot be created. The reference count of the object is incremented, so the client should call the object's Release method when finished using the object. Inputs part The part containing the source content of the link. Outputs <return> new ODLinkSource object Exceptions Signalled kODErrCannotCreateLink Cannot create the ODLinkSource or companion ODLink object. Pre conditions Exclusive-write or Shared-write permissions on this draft. Post conditions The returned instance is a fully functional ODLinkSource object. This draft is marked dirty. æKY ODDraft::CreateLinkSpec Draft::CreateLinkSpec Draft->CreateLinkSpec æT Class Method æD ODLinkSpec* CreateLinkSpec ( ODPart* part, ODByteArray* data); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Create a link spec for content in the argument part. This draft guarantees that a subsequent call to ODDraft::GetLink with the returned object as the link spec argument will resolve to the argument part. The ODLinkSpec object returned contains a copy of the argument data. LinkSpecs become invalid when the document creating the link spec is closed. If the link spec is being created prior to reading it from a storage unit, nil may be passed as the part and data arguments. The data parameter can contain any data which the part needs to create the specified link. An object specifier is recommended but not required. Inputs part The part object creating this link spec. data Arbitrary data for private use of the part in ODPart::CreateLink(). The client is responsible for disposing of the argument. Outputs <result> A new LinkSpec object. Exceptions Signalled None. Pre conditions None. Post conditions This Draft is marked dirty. æKY ODDraft::CreatePart Draft::CreatePart Draft->CreatePart æT Class Method æD ODPart* CreatePart( ODISOStr partType); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Creates a new Part in this Draft, constructs a ODPart to refer to the new Part and returns the ODPart object. Inputs partType Type of Part to create Outputs <return> new ODPart object Exceptions Signalled kODErrCannotCreatePart Cannot create ODPart object. Pre conditions Exclusive-write or Shared-write permissions on this Draft. Post conditions This Draft is marked dirty. æKY ODDraft::CreateStorageUnit Draft::CreateStorageUnit Draft->CreateStorageUnit æT Class Method æD ODStorageUnit* CreateStorageUnit(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Creates a new Storage Unit in this Draft, constructs a ODStorageUnit to refer to it and returns the ODStorageUnit object. Inputs none Outputs <return> new ODStorageUnit object Exceptions Signalled None. Pre conditions Exclusive-write or Shared-write permissions on this Draft. Post conditions This Draft is marked dirty. æKY ODDraft::EndClone Draft::EndClone Draft->EndClone æT Class Method æD void EndClone( ODDraftKey key); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation This function is used to end the transaction started by BeginClone. When this call returns, all the ODStorageUnits whose CloneTo method have been called should be copied to the destination ODDraft. Inputs key ODDraftKey which identifies the transaction. Outputs None. Exceptions Signalled kODErrInvalidDraftKey Pre conditions None. Post conditions All the ODStorageUnits whose CloneTo method have been called should be copied to the destination ODDraft. æKY ODDraft::Externalize Draft::Externalize Draft->Externalize æT Class Method æD ODDraft* Externalize(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Externalizes any internal structures of this ODDraft objects and also calls Externalize() on all the ODStorageUnits and ODPersistentObjects (and derived objects) instantiated through this draft. Inputs none Outputs <return> this ODDraft object. Exceptions Signalled None. Pre conditions Exclusive-write or Shared-write permissions on this Draft. Post conditions All ODStorageUnits and ODPersistentObjects (and derived objects) have been asked to Externalize. æKY ODDraft::GetDocument Draft::GetDocument Draft->GetDocument æT Class Method æD ODDocument* GetDocument(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns the ODDocument object from which this ODDraft object is created. Inputs none Outputs <return> fDocument Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODDraft::GetDraftProperties Draft::GetDraftProperties Draft->GetDraftProperties æT Class Method æD ODStorageUnit* GetDraftProperties(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns a ODStorageUnit object in which the Draft uses to store Draft Properties. Inputs none Outputs <return> this Draft's Draft Properties Storage Unit Exceptions Signalled kODErrNoDraftProperties Draft Properties Storage Unit cannot be created. Pre conditions None. Post conditions None. æKY ODDraft::GetFrame Draft::GetFrame Draft->GetFrame æT Class Method æD ODFrame* GetFrame( ODStorageUnitID id); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns a ODFrame object which refers to a Frame with the given id. Inputs id ID of the desired frame Outputs <return> A fully functional ODFrame object Exceptions Signalled kODErrCannotGetFrame Cannot create ODFrame object. Pre conditions ID refers to a valid Frame. Post conditions The return value is a fully functional ODFrame object with a reference count >= 1. æKY ODDraft::GetID Draft::GetID Draft->GetID æT Class Method æD ODDraftID GetID(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns the ID associated with this Draft. Inputs none Outputs <return> ID of this Draft. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODDraft::GetLink Draft::GetLink Draft->GetLink æT Class Method æD ODLink* GetLink( ODStorageUnitID id, ODLinkSpec* linkSpec); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns a ODLink object corresponding to the specification. If id is not 0, linkSpec is ignored. Otherwise, linkSpec is used to retrieve the Link. Inputs id ID of the desired link theLinkSpec a link spec from which a link is to be resolved or constructed Outputs <return> a fully functional ODLink object Exceptions Signalled kODErrCannotGetLink Cannot create ODLink object. Pre conditions id or linkSpec represents a valid Link on this Draft. Post conditions The return value is a fully functional ODLink object with a reference count >= 1. æKY ODDraft::GetLinkSource Draft::GetLinkSource Draft->GetLinkSource æT Class Method æD ODLinkSource* GetLinkSource( ODStorageUnitID id); æC Protection Public. Called by parts maintaining the source of a link, typically in their InitFromStorage method. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns the ODLinkSource object identified by the argument id. Since all ODLinkSource objects have a unique companion ODLink object, this method fails if the companion object does not exist and cannot be created. The reference count of the object is incremented, so the client should call the object's Release method when finished using the object. Inputs id ID of the desired link Outputs <return> a fully functional ODLink object Exceptions Signalled kODErrCannotGetLink Cannot create ODLink object. Pre conditions id represents a valid ODLinkSource object in this draft. Post conditions The return value is a fully functional ODLinkSource object with a reference count >= 1. æKY ODDraft::GetName Draft::GetName Draft->GetName æT Class Method æD ODDraftName* GetName(); æC Protection Public. Even though a Part can call this method, it should not need to know the name of its Draft. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns the name of this Draft. If this Draft does not have a name, kODNULL is returned. Inputs none Outputs <return> Name of this Draft. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODDraft::GetPart Draft::GetPart Draft->GetPart æT Class Method æD ODPart* GetPart( ODStorageUnitID id); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns a ODPart object which refers to the Part with the given id. Inputs id the id of the desired part Outputs <return> a fully functional ODPart object Exceptions Signalled kODErrCannotGetPart Cannot create ODPart object. Pre conditions id represents a valid Part in this Draft. Post conditions The return value is a fully functional ODPart object with a reference count >= 1. æKY ODDraft::GetPermissions Draft::GetPermissions Draft->GetPermissions æT Class Method æD ODDraftPermissions GetPermissions(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns the Permissions on the Draft. Inputs None. Outputs <return> Permissions on the Draft. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODDraft::GetPersistentObject Draft::GetPersistentObject Draft->GetPersistentObject æT Class Method æD ODPersistentObject GetPersistentObject( in ODPersistentObjectID objectID, out ODObjectType objectType); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Given an object id (gotten from GetPersistentObjectID), this function returns the corresponding persistent object and its type. Inputs objectID objectID Outputs <return> persistent object whose id is objectID objectType objectType of the persistent object Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODDraft::GetPersistentObjectID Draft::GetPersistentObjectID Draft->GetPersistentObjectID æT Class Method æD ODPersistentObjectID GetPersistentObjectID( in ODPersistentObject object, in ODObjectType type); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Given the ODPersistentObject and ODObjectType, this function returns an ODPersistentObjectID associated with the ODPersistentObject. This ODPersistentObjectID cannot be used to replace ODStorageUnitRef. This ID can only be used in the context of scripting. Inputs object ODPersistentObject whose id is desired. type Type of object (either kODPartObject or kODPartFrame). Outputs <return> Persistent Object ID Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODDraft::GetStorageUnit Draft::GetStorageUnit Draft->GetStorageUnit æT Class Method æD ODStorageUnit* GetStorageUnit( ODStorageUnitID id); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns a ODStorageUnit object which refers to a Storage Unit with the given id. Inputs id the id of the storage unit des9ired Outputs <return> a fully functional ODStorageUnit object Exceptions Signalled None. Pre conditions id represents a valid Storage Unit in this Draft. Post conditions The return value is a fully functional ODStorageUnit object with a reference count >= 1. æKY ODDraft::IncrementRefCount Draft::IncrementRefCount Draft->IncrementRefCount æT Class Method æD void IncrementRefCount(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Increments the reference count of this ODDraft object. Inputs none Outputs none Exceptions Signalled None. Pre conditions None. Post conditions The reference count of this object is incremented by 1. æKY ODDraft::InitDraft Draft::InitDraft Draft->InitDraft æT Class Method æD void InitDraft( ODDocument* document, ODDraftID id, ODDraftPermissions perms); æC Protection Public. Private within the Storage System. This method should only be called by ODDocument::CreateDraft or ODDocument::GetDraft. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Initializes this ODDraft object with the supplied parameters. Inputs document Document from which this ODDraft is created. id ID of this Draft. perms Access permissions for this ODDraft. Outputs none Exceptions Signalled None. Pre conditions None. Post conditions this is an initialized ODDraft object. æKY ODDraft::IsValidID Draft::IsValidID Draft->IsValidID æT Class Method æD ODBoolean IsValidID( ODID id); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Tests the argument object ID for validity. This method can be used to test the validity of an object ID returned by Clone or WeakClone, after EndClone has been called. Inputs id An object ID Outputs <return> kODTrue if id is a valid object ID, and kODFalse otherwise. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODDraft::Purge Draft::Purge Draft->Purge æT Class Method æD ODSize Purge( ODSize size); æC Protection Public. Private within the Storage System. This method should only be called by ODDocument::Purge. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Purge memory from ephemeral store until size bytes (not necessarily contiguous) have been freed up. Inputs size Number of bytes to purge Outputs <return> Number of bytes actually purged Exceptions Signalled None. Pre conditions None. Post conditions Either size bytes (not necessarily contiguous) are free in the default heap or Purge() has been called on every ODStorageUnit or ODPersistentObjects (and their derived objects) associated with this ODDraft object. æKY ODDraft::Release Draft::Release Draft->Release æT Class Method æD ODDocument* Release(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Releases this ODDraft object. Inputs none Outputs <return> fDocument Exceptions Signalled None. Pre conditions None. Post conditions this ODDraft object is no longer a valid ODDraft object. æKY ODDraft::ReleaseFrame Draft::ReleaseFrame Draft->ReleaseFrame æT Class Method æD void ReleaseFrame( ODFrame* frame); æC Protection Public. Private between ODDraft and ODFrame. ODFrame::Release calls this method when its refCount goes down to 0. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Releases the ODFrame object. Inputs frame ODFrame object to be released Outputs none Exceptions Signalled kODErrInvalidRefCount RefCount of object is not 0. Pre conditions frame is a ODFrame object with a refCount of 0. Post conditions None. æKY ODDraft::ReleaseLink Draft::ReleaseLink Draft->ReleaseLink æT Class Method æD void ReleaseLink( ODLink* link); æC Protection Public. Private between ODDraft and ODLink. ODLink::Release calls this method when its refCount goes down to 0. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Releases the ODLink object. Inputs link ODLink object to be released Outputs none Exceptions Signalled kODErrInvalidRefCount Refcount of link is not 0. Pre conditions link is a ODLink object with a refCount of 0. Post conditions None. æKY ODDraft::ReleasePart Draft::ReleasePart Draft->ReleasePart æT Class Method æD void ReleasePart( ODPart* part); æC Protection Public. Private between ODPart and ODDraft. ODPart::Release calls this method when its refCount goes down to 0. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Releases the given ODPart object. Inputs part ODPart object to be released Outputs none Exceptions Signalled kODErrInvalidRefCount RefCount of part is not 0. Pre conditions part is a ODPart object with a refCount of 0. Post conditions None. æKY ODDraft::ReleaseStorageUnit Draft::ReleaseStorageUnit Draft->ReleaseStorageUnit æT Class Method æD ODDraft* ReleaseStorageUnit( ODStorageUnit* storageUnit); æC Protection Private. Private within the Storage System. ODStorageUnit::Release calls this method when its refCount goes down to 0. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Decrement the reference count for the given ODStorageUnit object. Inputs storageUnit ODStorageUnit object to be released Outputs <return> this Exceptions Signalled kODErrInvalidRefCount Refcount of storageUnit is not 0. Pre conditions storageUnit is a ODStorageUnit object with a refCount of 0. Post conditions None. æKY ODDraft::RemoveChanges Draft::RemoveChanges Draft->RemoveChanges æT Class Method æD ODDraft* RemoveChanges(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Removes any changes been made between this Draft and the Draft immediately below it. Inputs none Outputs <return> this Exceptions Signalled None. Pre conditions this Draft is "gotten" with kDPExclusiveWrite perms. Post conditions this Draft is 'empty'. æKY ODDraft::RemoveFrame Draft::RemoveFrame Draft->RemoveFrame æT Class Method æD void RemoveFrame( ODFrame* frame); æC Protection Public. Private between ODDraft and ODFrame. This method should only be called by ODFrame::Remove. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Removes the frame persistently from the Draft and destroys the ODFrame associated with it. Inputs frame the frame to be removed Outputs none Exceptions Signalled kODErrInvalidStorageUnit Invalid ODFrame with no ODStorageUnit associated with it. kODErrInvalidRefCount RefCount of frame is not 1. Pre conditions The refcount of the given ODFrame object is 1. The permissions of this ODDraft are kDPExclusiveWrite or kDPSharedWrite. Post conditions frame is no longer a valid ODFrame object. this Draft no longer contains a Frame with the corresponding id. æKY ODDraft::RemoveFromDocument Draft::RemoveFromDocument Draft->RemoveFromDocument æT Class Method æD void RemoveFromDocument(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Removes this Draft persistently from its Document and destroys the ODDraft associated with it. Inputs none Outputs none Exceptions Signalled None. Pre conditions This ODDraft is gotten with write permissions. This Draft is 'empty'. This Draft is not the Base Draft. Post conditions this object is no longer a valid ODDraft. The Draft which used to be directly above this one is now directly above the Draft which used to be below this one. æKY ODDraft::RemoveLink Draft::RemoveLink Draft->RemoveLink æT Class Method æD void RemoveLink( ODLink* link); æC Protection Public. Private between ODDraft and ODLink. This method should only be called by ODLink::Remove. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Removes the Link referred to by link from this Draft. Inputs link Link to be removed Outputs none Exceptions Signalled kODErrInvalidRefCount Refcount of link is not 1. kODErrInvalidStorageUnit Invalid ODLink with no ODStorageUnit associated with it. Pre conditions The refcount of the given ODLink object is 1. The permissions of this ODDraft are kDPExclusiveWrite or kDPSharedWrite. Post conditions link is no longer a valid ODLink object This Draft no longer contains a Link with the corresponding id. æKY ODDraft::RemoveLinkSource Draft::RemoveLinkSource Draft->RemoveLinkSource æT Class Method æD void RemoveLinkSource( ODLinkSource* link); æC Protection Public. Private for use only by ODLinkSource. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Removes the ODLinkSource referred to by link from this draft. Inputs link Link to be removed Outputs None. Exceptions Signalled kODErrInvalidRefCount Refcount of link is not 1. kODErrInvalidStorageUnit Invalid ODLinkSource with no ODStorageUnit associated with it. Pre conditions The refcount of the link argument is 1. The permissions of this draft are kDPExclusiveWrite or kDPSharedWrite. Post conditions link is no longer a valid ODLinkSource object. This draft no longer contains a ODLinkSource object with the corresponding id. æKY ODDraft::RemovePart Draft::RemovePart Draft->RemovePart æT Class Method æD void RemovePart( ODPart* part); æC Protection Public. Private between ODDraft and ODPart. This method should only be called by ODPart::Remove. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Removes from this Draft the Part referred to by the given ODPart object. Inputs part Part to be removed Outputs none Exceptions Signalled kODErrInvalidRefCount Refcount of part is not 1. kODErrInvalidStorageUnit Invalid ODPart with no ODStorageUnit associated with it. Pre conditions The refcount of the given ODPart object is 1. The permissions of this ODDraft object are kDPExclusiveWrite or kDPSharedWrite. Post conditions part is no longer a valid ODPart object. This Draft no longer contains a Part with the corresponding id. æKY ODDraft::RemoveStorageUnit Draft::RemoveStorageUnit Draft->RemoveStorageUnit æT Class Method æD void RemoveStorageUnit( ODStorageUnit* storageUnit); æC Protection Public. Private with the Storage System. This method should only be called by ODStorageUnit::Remove. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Removes from this Draft the Storage Unit referred to by the ODStorageUnit object. Inputs storageUnit Storage unit to be removed Outputs none Exceptions Signalled kODErrInvalidStorageUnit Invalid storageUnit. Pre conditions The refcount of the given ODStorageUnit object is 1. The permissions of this ODDraft are kDPExclusiveWrite or kDPSharedWrite. Post conditions storageUnit is no longer a valid ODStorageUnit object. This Draft no longer contains a storage unit with the corresponding id. æKY ODDraft::SaveToAPrevious Draft::SaveToAPrevious Draft->SaveToAPrevious æT Class Method æD ODDraft* SaveToAPrevious( ODDraft* to); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation same as ODDocument::SaveToAPrevDraft(this,to). Inputs to draft to move changes to Outputs <return> this Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODDraft::SetChangedFromPrev Draft::SetChangedFromPrev Draft->SetChangedFromPrev æT Class Method æD void SetChangedFromPrev(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Marks this Draft dirty (i.e., ChangedFromPrev). Parts can call this method to mark the Draft dirty. The dirty state of the Draft will trigger externalization when the Draft is closed. Note that a Draft cannot be marked clean after it has been marked dirty. However, RemoveChanges can be called to remove all the changes in this Draft. Inputs None Outputs None Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODDraft::SetName Draft::SetName Draft->SetName æT Class Method æD void SetName( ODDraftName name); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Sets the name of this Draft. Inputs name New name of this draft Outputs none Exceptions Signalled None. Pre conditions name represents a valid ODDraftName. Post conditions None. æKY ODDraft::WeakClone Draft::WeakClone Draft->WeakClone æT Class Method æD ODID WeakClone( in ODDraftKey key, in ODID fromObjectID, in ODID toObjectID, in ODID scope); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation This method works the same as Clone except that it is used to clone persistent objects or storage units which are only weakly referenced. Inputs fromObjectID ID of the persistent object or storage unit to be cloned. scope The scope of the clone (usually refer to the frame in which the persistent object or storage unit is contained). toObjectID ID of the duplicated persistent object or storage unit. key key of the current cloning transaction Outputs <return> ID of the duplicated persistent object or storage unit Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODDraft::fDocument Draft::fDocument æT Class Field æD ODDocument* æC Persistent form None. æKY ODDraft::fFrames Draft::fFrames æT Class Field æD ODSCollection* æC Persistent form None. æKY ODDraft::fID Draft::fID æT Class Field æD ODDraftID æC Persistent form ID kODPropDraftID stores the id of the draft æKY ODDraft::fLinks Draft::fLinks æT Class Field æD ODSCollection* æC Persistent form None. æKY ODDraft::fName Draft::fName æT Class Field æD ODDraftName æC Persistent form Name kODPropDraftName stores the name of the draft æKY ODDraft::fParts Draft::fParts æT Class Field æD ODSCollection* æC Persistent form None. æKY ODDraft::fPermissions Draft::fPermissions æT Class Field æD ODDraftPermissions æC Persistent form None. æKY ODDraft::fStorageUnits Draft::fStorageUnits æT Class Field æD ODSCollection* æC Persistent form None. æKY ODDragAndDropHelp ODDragAndDrop DragAndDrop æKL ODDragAndDrop::ODDragAndDrop ODDragAndDrop::~ODDragAndDrop ODDragAndDrop::Clear ODDragAndDrop::GetContentStorageUnit ODDragAndDrop::GetDragAttributes ODDragAndDrop::GetDragReference ODDragAndDrop::InitDragAndDrop ODDragAndDrop::Purge ODDragAndDrop::ShowPasteAsDialog ODDragAndDrop::StartDrag æC Basic Class Documentation Platform implementors should implement this class to provide the functionality of a OpenDoc Drag and Drop mechanism. This class depends on system services provided by the platform. They include a clipboard-like service where data can be transfered within a process or between processes, and a system-wide mouse tracking service which can notify a process about the location (i.e., whether the mouse is entering, leaving or in a window of the process) and the state of the mouse (i.e., whether there is a mouse-down or mouse-up). This class provides the basic mechanism for dragging an object within a part, between parts, and between an OpenDoc document and a non-OpenDoc application. At the process' startup time, a ODDragAndDrop object is instantiated and stored with the ODSession object. Theory of Operation The main client of this class is ODPart. Any part can initiate a drag. Whenever a part needs to use the Drag-and-Drop mechanism, it can acquire the ODDragAndDrop object through the ODSession object. When a mouse-down is detected within a frame, the part has the choice of initiating a drag. This involves acquiring the drag focus (to be thread-safe), getting the ODDragAndDrop object from the ODSession, copying the data for the dragged object to the ODDragAndDrop object (through a ODStorageUnit supplied by the ODDragAndDrop object) and starting a drag action. Once the drag is initiated, the ODDragAndDrop object will notify the Frame when the mouse passes over it. If the mouse is released over a Frame, it will be notified of the drop and it can retrieve the data for the dragged object from the supplied ODStorageUnit object. As mentioned above, copying data to and from the ODDragAndDrop object is done through a ODStorageUnit. Invariants Maintained by Class Note that the client of this class should never cache the ODDragAndDrop object nor its ODStorageUnit. Instead, it should always get these objects through ODSession and ODDragAndDrop APIs whenever they are needed. æKY ODDragAndDrop::ODDragAndDrop DragAndDrop::ODDragAndDrop DragAndDrop->ODDragAndDrop æT Class Method æD ODDragAndDrop(); æC Protection Public. This method is called once by ODSession::InitSession. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation This function is the constructor of the ODDragAndDrop object. It is called once at the process' startup time. Inputs None Outputs None Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODDragAndDrop::~ODDragAndDrop DragAndDrop::~ODDragAndDrop DragAndDrop->~ODDragAndDrop æT Class Method æD ~ODDragAndDrop(); æC Protection Public. This method should only be called by ODSession::~ODSession. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation This function is the destructor for the ODDragAndDrop object. It is called once when OpenDoc quits. It should close all the required system services that it has initialized. Inputs None Outputs None Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODDragAndDrop::Clear DragAndDrop::Clear DragAndDrop->Clear æT Class Method æD void Clear(); æC Protection Public. None. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation This function removes all the user data stored in the ODDragAndDrop object. This is called by a Part before it is going to put data into this object for transfer. Inputs None Outputs None Exceptions Signalled None. Pre conditions None. Post conditions The ODStorageUnit should be empty. æKY ODDragAndDrop::GetContentStorageUnit DragAndDrop::GetContentStorageUnit DragAndDrop->GetContentStorageUnit æT Class Method æD ODStorageUnit* GetContentStorageUnit(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation This function returns an ODStorageUnit object. The caller should copy data to the ODDragAndDrop object through the ODStorageUnit object. To ensure that the ODStorageUnit is empty, Clear() should be called immediately after GetStorageUnit() is called. Inputs None Outputs <return> An empty ODStorageUnit object for the caller to copy the data to. Exceptions Signalled None. Pre conditions None. Post conditions An empty ODStorageUnit is returned. æKY ODDragAndDrop::GetDragAttributes DragAndDrop::GetDragAttributes DragAndDrop->GetDragAttributes æT Class Method æD ODULong GetDragAttributes(); æC Protection Public. This is a Macintosh specific function used to give the parts additional information about a drag. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation This function returns a flag word containing info about the current drag. The following flags are used: #define kODdragHasLeftSourceFrame 0x00000001 #define kODdragIsInSourcePart 0x00000002 #define kODdragIsInSourceFrame 0x00000004 If no drag is currently in progress, the result is 0. The contents of the flag word are intended to help the part determine if user feedback is neccessary and to help the part efficiently handle the contents of the drag. Inputs None Outputs ODULong Flag word contianing info on the current drag. Exceptions Signalled None. Pre conditions A drag must be in progress. Post conditions None. æKY ODDragAndDrop::GetDragReference DragAndDrop::GetDragReference DragAndDrop->GetDragReference æT Class Method æD DragReference GetDragReference(); æC Protection Public. This is a Macintosh specific function that returns the paltform specific DragReference associated with the current drag. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation This function returns the Drag Manager dragReference associated with the current drag. If no drag is under way, 0 is returned. Parts should use this function to enable direct calls to the Drag Manager utilities to do window highliting. Inputs None Outputs DragReference Paltform specific drag reference number Exceptions Signalled None. Pre conditions A drag must be in progess. Post conditions None. æKY ODDragAndDrop::InitDragAndDrop DragAndDrop::InitDragAndDrop DragAndDrop->InitDragAndDrop æT Class Method æD void InitDragAndDrop(); æC Protection Public. This method should only be called by ODSession::InitSession. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation It initializes all the required system services which include a drag mechanism and a data transfer mechanism. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions this is an initialized ODDragAndDrop object. æKY ODDragAndDrop::Purge DragAndDrop::Purge DragAndDrop->Purge æT Class Method æD ODSize Purge( ODSize size); æC Protection Public. This method is only called by ODSession::Purge. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Purges all the ephemeral structures in this object. Inputs size Number of bytes to purge. Outputs <return> Number of bytes actually purged. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODDragAndDrop::ShowPasteAsDialog DragAndDrop::ShowPasteAsDialog DragAndDrop->ShowPasteAsDialog æT Class Method æD ODBoolean ShowPasteAsDialog( ODBoolean canPasteLink, ODPasteAsMergeSetting mergeSetting, ODFacet* facet, ODTypeToken viewType, ODStorageUnit* contentSU, ODPasteAsResult* result); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation This function shows the Paste As Dialog and sets the appropriate dialog items according to the input parameters. If the function returns kODFalse, that means the user cancels out of the dialog. Otherwise, the output parameter result shows what kind of action the client of ShowPasteAsDialog should perform. Inputs canPasteLink boolean showing a link can be pasted. mergeSetting Specifies if merging and/or embedding is supported, and determines the initial setting. facet Facet from which the Paste As Dialog is triggered. viewType View Type of the transfered data contentSU The storage unit containing the content being dropped. Outputs <return> boolean showing whether the user clicks OK. result Result reflecting the user 's choice. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODDragAndDrop::StartDrag DragAndDrop::StartDrag DragAndDrop->StartDrag æT Class Method æD ODDropResult StartDrag( ODFrame* srcFrame, ODValueType imageType, ODByteArray* image, ODPart** destPart, ODByteArray* refCon); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation This function initiates a drag. It shows the image supplied by the caller and allows the user to drag this image on the screen. Whenever the mouse passes over a Droppable Frame, it will notify the frame about the mouse location and the mouse state. If a drop occurs over a Droppable Frame, it will notify the frame. If the call is implemented synchronously, it will also return the destination part. Inputs srcFrame Frame in which the drag is initiated. imageType Type of the image being dragged. image Data of the image being dragged. refCon Extra information needed for dragging (mainly for platform specific data). Outputs <return> kDropSucceed means a drop is successful. kDropFail means the drop is unsuccessful. kDropUnfinished means the drop is not completed yet. destPart If kDropSucceed is returned as the function result, destPart contains the destination part. Otherwise, the content of this parameter is undefined. Exceptions Signalled None. Pre conditions ODStorageUnit must contain client data from the Part initiating the drag. Post conditions None. æKY ODDragItemIteratorHelp ODDragItemIterator DragItemIterator æKL ODDragItemIterator::ODDragItemIterator ODDragItemIterator::~ODDragItemIterator ODDragItemIterator::First ODDragItemIterator::IsNotComplete ODDragItemIterator::Next ODDragItemIterator::fDragItemListIter æC Basic Class Documentation ODDragItemIterator is a companion of ODDragAndDrop. Given the state of the ODDragAndDrop object, ODDragItemIterator allows a Part to iterate over all the ODStorageUnits in the drag with a loop, using the iterator's First(), Next() and IsNotComplete() methods. ODDragItemIterator is implemented together with ODDragAndDrop by platform implementors. Theory of Operation Once a drag is initiated, the ODDragAndDrop object will notify a Frame when the mouse passes over it. Besides the mouse location, the ODDragAndDrop object also supplies the Part with a ODDragItemIterator. If the mouse is released over a Frame, it will be notified of the mouse location and be supplied with a ODDragItemIterator. In both cases, the Part can use it to iterate over all the Drag Items and decide whether it can accept the Drop. Invariants Maintained by Class ODDragItemIterator maintains a reference to the list of drag items registered with the ODDragAndDrop object. æKY ODDragItemIterator::ODDragItemIterator DragItemIterator::ODDragItemIterator DragItemIterator->ODDragItemIterator æT Class Method æD ODDragItemIterator( LinkedList* dragItemList); æC Protection Public. Private between ODDragItemIterator and ODDragAndDrop. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Constructs the iterator Inputs dragItemList The item list over which to iterate Outputs None Exceptions Signalled kODErrInvalidWindowState The specified window state is not valid. Pre conditions None. Post conditions A properly constructed drag item iterator. æKY ODDragItemIterator::~ODDragItemIterator DragItemIterator::~ODDragItemIterator DragItemIterator->~ODDragItemIterator æT Class Method æD ~ODDragItemIterator(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Frees the memory allocated by this class. Inputs None Outputs None Exceptions Signalled None. Pre conditions A constructed object of this class. Post conditions The memory used by this class is freed. æKY ODDragItemIterator::First DragItemIterator::First DragItemIterator->First æT Class Method æD ODStorageUnit* First(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the first storage unit in the drag item list. Inputs None Outputs <return> The first storage unit in the drag item list. kODNULL if none. Exceptions Signalled None. Pre conditions A constructed object of this class. Post conditions Result contains the first storage unit. æKY ODDragItemIterator::IsNotComplete DragItemIterator::IsNotComplete DragItemIterator->IsNotComplete æT Class Method æD ODBoolean IsNotComplete(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns kODTrue if there are more storage units, kODFalse otherwise. Inputs None Outputs <return> kODTrue, if there are more windows Exceptions Signalled None. Pre conditions A constructed object of this class. Post conditions Result contains kODTrue if there are more storage units, kODFalse otherwise. æKY ODDragItemIterator::Next DragItemIterator::Next DragItemIterator->Next æT Class Method æD ODStorageUnit* Next(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the next storage unit in the drag item list. Inputs None Outputs <return> The next storage unit in the drag item list. kODNULL if none. Exceptions Signalled None. Pre conditions First() has been called. Post conditions Result contains the next storage unit. æKY ODDragItemIterator::fDragItemListIter DragItemIterator::fDragItemListIter æT Class Field æD LinkedListIterator *fDragItemListIter; æC æKY ODEmbeddedFramesIteratorHelp ODEmbeddedFramesIterator EmbeddedFramesIterator æKL ODEmbeddedFramesIterator::First ODEmbeddedFramesIterator::IsNotComplete ODEmbeddedFramesIterator::Next æC Basic Class Documentation An ODEmbeddedFramesIterator is used to iterate the embedded frames of a containing part. This class has no base class. It is typically a friend of the part class whose frames it iterates. This class is implemented by a part developer along with a containing part class. ODEmbeddedFramesIterator instances are created by their containing parts. A client calls ODPart::CreateEmbeddedFramesIterator to obtain an iterator for a part's embedded frames. Theory of Operation Invariants Maintained by Class Varies according to implementation. æKY ODEmbeddedFramesIterator::First EmbeddedFramesIterator::First EmbeddedFramesIterator->First æT Class Method æD ODFrame* First(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Initialize the iteration sequence and return the first embedded frame of my part. Inputs None. Outputs <return> The first embedded frame of my part. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODEmbeddedFramesIterator::IsNotComplete EmbeddedFramesIterator::IsNotComplete EmbeddedFramesIterator->IsNotComplete æT Class Method æD ODBoolean IsNotComplete(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Answer whether there are more frames left in the iteration sequence. Inputs None. Outputs <return> A boolean reflecting whether to continue the iteration. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODEmbeddedFramesIterator::Next EmbeddedFramesIterator::Next EmbeddedFramesIterator->Next æT Class Method æD ODFrame* Next(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the next embedded frame in the iteration sequence. Inputs None. Outputs <return> The next embedded frame of my part. Exceptions Signalled None. Pre conditions First() must have been previously called. IsNotComplete() must return kODTrue. Post conditions Iteration sequence is advanced to next frame. æKY ODExtensionHelp ODExtension Extension æKL ODExtension::ODExtension ODExtension::~ODExtension ODExtension::BaseRemoved ODExtension::CheckValid ODExtension::GetBase ODExtension::InitExtension ODExtension::IsValid ODExtension::Release ODExtension::fBase æC Basic Class Documentation ODExtension is the abstract base class from which object extension interfaces are derived. The base class itself has minimal behavior. It knows which object it is an extension of, and how to release resources in itself and in its object. Further behavior should be implemented in derived classes. This class has no base class. Extensions will typically share friendship with their base object class. Both platform vendors and part developers will use extensions to extend standard interfaces. Theory of Operation ODExtension is the abstract base class from which object extension interfaces are derived. The base class itself has minimal behavior. It knows which object it is an extension of, and how to release resources in itself and in its object. Further behavior should be implemented in derived classes. Invariants Maintained by Class fBase contains a valid base object for this extension. æKY ODExtension::ODExtension Extension::ODExtension Extension->ODExtension æT Class Method æD ODExtension( ODObject* base); æC Protection Protected. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Construct a new extension instance. Inputs base The base object for this extension. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions fBase holds base object for this extension. æKY ODExtension::~ODExtension Extension::~ODExtension Extension->~ODExtension æT Class Method æD ~ODExtension(); æC Protection Protected. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Deallocate this instance and its storage. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions This instance must have been previously "released". Post conditions This instance is no longer usable by clients. æKY ODExtension::BaseRemoved Extension::BaseRemoved Extension->BaseRemoved æT Class Method æD ; æC Protection Public. Override policy Derived class can override. Derived class must call base class behavior, during derived class behavior. Basic operation This method notifies the extension object that it's base object has been removed. The extension should no longer attempt to communicate with the base object. Any pointers which the extension object had back to the base object should be considered invalid. After this call the extension is invalid. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions The extension object has a valid base. Post conditions The extension object no longer has a base and is therefore invalid. æKY ODExtension::CheckValid Extension::CheckValid Extension->CheckValid æT Class Method æD void CheckValid(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, before derived class behavior. Basic operation Every subclass of extension must call this ODExtension method at the beginning of the implementation of each of their new methods (aside from the Init… method). This method does nothing if the extension object is valid. If the extension object is invalid, then an error is generated. Inputs None. Outputs None. Exceptions Signalled kODErrInvalidExtension This is an invalid extension and should not be used by any clients. The client should attempt to get the extension from the same base object she got it from before. Pre conditions None. Post conditions None. æKY ODExtension::GetBase Extension::GetBase Extension->GetBase æT Class Method æD ODObject* GetBase(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the object of which this instance is an extension. Inputs None. Outputs <return> The base of this extension. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODExtension::InitExtension Extension::InitExtension Extension->InitExtension æT Class Method æD void InitExtension( ODObject* base); æC Protection Protected. Override policy Derived class must override. Derived class must call base class behavior, before derived class behavior. Basic operation Prepare this object for use. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions fBase is a valid base object Post conditions This object is ready for use by clients. æKY ODExtension::IsValid Extension::IsValid Extension->IsValid æT Class Method æD ODBoolean IsValid(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, before derived class behavior. Basic operation This method can be used by a client of an extension object to verify whether or not the extension object is still valid. An extension becomes invalid when its base object is removed. Inputs None. Outputs <return> Whether or not the extension object is valid. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODExtension::Release Extension::Release Extension->Release æT Class Method æD void Release(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Tell my base object to release connection to me. Prepare to be deleted. Inputs None. Outputs None. Exceptions Signalled kODErrInvalidBase Not a valid base object. Pre conditions fBase is a valid base object. Post conditions This extension is no longer usable. æKY ODExtension::fBase Extension::fBase æT Class Field æD ODObject* æC æKY ODFacetHelp ODFacet Facet æKL ODFacet::ODFacet ODFacet::~ODFacet ODFacet::ActiveBorderContainsPoint ODFacet::ChangeActiveShape ODFacet::ChangeGeometry ODFacet::ChangeHighlight ODFacet::ContainsPoint ODFacet::CreateCanvas ODFacet::CreateEmbeddedFacet ODFacet::CreateFacetIterator ODFacet::CreateShape ODFacet::CreateTransform ODFacet::DragEnter ODFacet::DragLeave ODFacet::DragWithin ODFacet::Draw ODFacet::DrawActiveBorder ODFacet::DrawChildren ODFacet::DrawChildrenAlways ODFacet::DrawnIn ODFacet::Drop ODFacet::GetActiveShape ODFacet::GetAggregateClipShape ODFacet::GetCanvas ODFacet::GetClipShape ODFacet::GetContainingFacet ODFacet::GetContentTransform ODFacet::GetExternalTransform ODFacet::GetFrame ODFacet::GetFrameTransform ODFacet::GetHighlight ODFacet::GetNode ODFacet::GetPartInfo ODFacet::GetWindow ODFacet::GetWindowAggregateClipShape ODFacet::GetWindowContentTransform ODFacet::GetWindowFrameTransform ODFacet::HasCanvas ODFacet::InitChildFacet ODFacet::InitFacet ODFacet::InternalTransformChanged ODFacet::Invalidate ODFacet::InvalidateActiveBorder ODFacet::InvalidateAggregateClipShape ODFacet::InvalidateAggregateTransforms ODFacet::IsSelected ODFacet::MouseEnter ODFacet::MouseLeave ODFacet::MouseWithin ODFacet::MoveBefore ODFacet::MoveBehind ODFacet::NeedsUpdate ODFacet::Purge ODFacet::RemoveFacet ODFacet::SetCanvas ODFacet::SetNeedsUpdate ODFacet::SetPartInfo ODFacet::SetSelected ODFacet::Update ODFacet::Validate ODFacet::fActiveShape ODFacet::fAggregateClipShape ODFacet::fCanvas ODFacet::fClipShape ODFacet::fContentTransform ODFacet::fExternalTransform ODFacet::fFrame ODFacet::fFrameTransform ODFacet::fHighlight ODFacet::fIsSelected ODFacet::fNeedsUpdate ODFacet::fNode ODFacet::fPartInfo ODFacet::fWindowAggregateClipShape ODFacet::fWindowContentTransform ODFacet::fWindowFrameTransform æC Basic Class Documentation Ancestors: ODFacet -> ODObject Part developers will not subclass ODFacet. Platform implementors can subclass if needed, but that should not normally be necessary. ODFacet objects hold non-persistent information about the layout of a document. They are used to place a frame on a canvas for display and event dispatching. There will be one facet for each place a frame is visible in a window. Facets may exist for frames which have been previously visible, such as those that have been scrolled out of view, or may be eagerly created for frames which are expected to become visible soon. Facets which are not currently visible in a window are liable to be purged from memory in a low-memory condition. Parts create facets for each place they display an embedded frame. In most cases, a containing part will only have one facet for an embedded frame in each facet of the containing part's display frame. But in some cases, a containing part will want to display the same embedded frame in several places. This can easily be accomplished by creating one facet for each place the containing part wants to display the embedded frame. Facets are organized hierarchically. There is one root facet for each window or printing page, and all other facets in that window descend from it. All facets for the same frame must be contained within facets of their frame's containing frame. There can be mulitple facets displaying the same frame. All parts should support multiple facets on a frame. In most cases all facets on the same frame will display their contents identically. For cases where the part wishes to display facets differently, it may store "partInfo" data in the facets to distinguish them. A facet holds some extra information about the geometry of its frame. In addition to the frame's own frame shape, it also maintains a clip shape and an active shape. The clip shape describes the area in which the facet's part may display itself; it is controlled by the containing part. The active shape describes where the facet's part is sensitive to geometry-based UI events such as mouse clicks. The embedded part controls the active shape. Both shapes are represented in the frame's coordinate space. A facet also has an external transform, which describes where it is located within its containing part's coordinate space. Any facet can have its own canvas. In that case, the facet and all its children will display themselves on that canvas. This can be used to do off-screen double-buffering, image combination, etc. Either the facet's part or the facet's containing part can decide to move the facet to its own canvas. Whichever part makes the decision must create the canvas and register as its owner. That part is then responsible for moving the data from the facet's canvas to the parent canvas. A facet maintains some extra state information used for display and event dispatching. The "isSelected" flag indicates whether the facet is selected, so the dispatcher can determine whether to dispatch events into it. The "highlight" field indicates if the facet is part of a larger selection, and if so how its part needs to alter its imaging for selection highlighting. Facets can be thought of as describing the layout environment of a frame. Since a facet can exist simultaneously in both a window and an offscreen canvas, there are sometimes two environments to consider. The aggregate clip shape and aggregate transforms are both distinguished by which environment, canvas or window, the part wants to display in. In most cases, the part will display in the canvas environment. But for real-time interaction like rubber-banding or dragging, the part may want to display directly in the window. In those cases, it should use the aggregates for the window environment. Theory of Operation Invariants Maintained by Class An ODFacet object always has a frame, and that frame cannot be changed during the lifetime of the facet. The clip shape and external transform must always be valid. Only the root facet of a window may have its window field set. Non-root facets must have a containing facet. æKY ODFacet::ODFacet Facet::ODFacet Facet->ODFacet æT Class Method æD ODFacet(); æC Protection Public. Override policy Derived class must override. Derived class must call base class behavior, before derived class behavior. Basic operation Class constructor. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions Must call InitFacet before returned instance is ready to use. æKY ODFacet::~ODFacet Facet::~ODFacet Facet->~ODFacet æT Class Method æD ~ODFacet(); æC Protection Public. Override policy Derived class must override. Derived class must call base class behavior, after derived class behavior. Basic operation Class destructor. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::ActiveBorderContainsPoint Facet::ActiveBorderContainsPoint Facet->ActiveBorderContainsPoint æT Class Method æD ODBoolean ActiveBorderContainsPoint( ODPoint point, ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return whether the point is within the active border adornment for this facet. Inputs point The location to test. In window coordinates. biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs <return> True if the point is within the facet's border shape, false otherwise. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::ChangeActiveShape Facet::ChangeActiveShape Facet->ChangeActiveShape æT Class Method æD void ChangeActiveShape( ODShape* activeShape, ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Set the facet's active shape, and notify UI subsystem dependents. Only the facet's part should change its active shape. Inputs activeShape The new active shape for the facet. biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::ChangeGeometry Facet::ChangeGeometry Facet->ChangeGeometry æT Class Method æD void ChangeGeometry( ODShape* clipShape, ODTransform* transform, ODCanvas* biasCanvas); æC Protection Public. Called by containing part. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Set the facet's clip shape and/or its externalTransform, and notify the facet's part of the change via Part::GeometryChanged(). Invalidate any cached aggregate clip shape and transforms. Only the facet's containing part (or window) should change its geometry. Inputs clipShape The new clip shape for the facet. transform The new external transform for the facet. biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::ChangeHighlight Facet::ChangeHighlight Facet->ChangeHighlight æT Class Method æD void ChangeHighlight( ODHighlight highlight); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Set the highlight state of this facet, and notify its part via Part::HighlightChanged(). Inputs highlight The new highlight state of the facet. One of kODNoHighlight, kODFullHighlight, kODDimHighlight. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::ContainsPoint Facet::ContainsPoint Facet->ContainsPoint æT Class Method æD ODBoolean ContainsPoint( ODPoint point, ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return whether the point is within the facet. Transform the point to frame coordinates and test versus the intersection of the clip and active shapes. Inputs point The location to test. In window coordinates. biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs <return> True if the point is within the facet's shape, false otherwise. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::CreateCanvas Facet::CreateCanvas Facet->CreateCanvas æT Class Method æD ODCanvas* CreateCanvas( ODGraphicsSystem graphicsSystem, ODPlatformCanvas platformCanvas, ODBoolean isDynamic, ODBoolean isOffscreen); æC Protection Public. Called by parts to create new canvas objects. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation This method is used by parts to obtain new canvas instances. Inputs graphicsSystem graphicsSystem for the new canvas. platformCanvas platformCanvas of the new canvas. isDynamic isDynamic setting of the new canvas isOffscreen isOffscreen setting of the new canvas Outputs <return> The new canvas instance. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::CreateEmbeddedFacet Facet::CreateEmbeddedFacet Facet->CreateEmbeddedFacet æT Class Method æD ODFacet* CreateEmbeddedFacet( ODFrame* frame, ODShape* clipShape, ODTransform* externalTransform, ODCanvas* canvas, ODCanvas* biasCanvas, ODFacet* siblingFacet, ODFramePosition position); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Asks a facet to create an embedded facet. This should be requested by the facet's part when it needs to create a facet for one of its embedded frames. The new facet's part will be notified that a new facet has been added to its frame [ODPart::FacetAdded(facet)]. Inputs frame The frame the new facet will display. clipShape The initial clip shape for the new facet. externalTransform The initial external transform for the new facet. siblingFacet An existing child facet of the receiver. May be kODNULL. position The desired position of the new facet relative to the siblingFacet. Legal values are kODFrameBehind or kODFrameInFront. If siblingFacet is kODNULL, the new facet will be placed at the front or back of all siblings. canvas The canvas the facet should display on, as provided by the containing part. May be kODNULL if it is the same as that of the containing facet. biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs <return> The new facet. Exceptions Signalled kODInvalidFacet "siblingFacet" is not a child of the receiver. kODErrInvalidPositionCode "position" is not a valid position code. Pre conditions The receiving facet is a facet of the containingFrame of the "frame" parameter. "siblingFacet" is a child facet of the receiving facet. Post conditions The returned facet is a child facet of the receiving facet, with clipShape and externalTransform set to the indicated values. æKY ODFacet::CreateFacetIterator Facet::CreateFacetIterator Facet->CreateFacetIterator æT Class Method æD ODFacetIterator* CreateFacetIterator( ODTraversalType traversalType, ODSiblingOrder siblingOrder); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Create an iterator for the children facet of the receiver. It is the caller's responsibility to delete the iterator when done using it. The iterator can be used to walk the entire tree of facets from the receiver on down, or just the receiver's immediate children. Inputs traversalType may be kODTopDown, kODBottomUp, or kODChildrenOnly. The first two include the receiver in the traversal. siblingOrder May be kODFrontToBack or kODBackToFront. Controls the order in which facets are visited during traversal. Outputs <return> The new iterator. Caller assumes responsibility for memory. Exceptions Signalled None. Pre conditions None. Post conditions New iterator has been created and is ready to use. æKY ODFacet::CreateShape Facet::CreateShape Facet->CreateShape æT Class Method æD ODShape* CreateShape(); æC Protection Public. Called by parts to create new shape objects. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation This method is called by parts to obtain new shape instances. Inputs None. Outputs <return> The new shape object. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::CreateTransform Facet::CreateTransform Facet->CreateTransform æT Class Method æD ODShape* CreateTransform(); æC Protection Public. Called by parts to create new transform objects. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation This method is called by parts to obtain new transform instances. Inputs None. Outputs <return> The new transform object. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::DragEnter Facet::DragEnter Facet->DragEnter æT Class Method æD void DragEnter( ODPoint point, ODDragItemIterator* dragInfo, ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Begin a drag operation in the facet. The facet will transform the point into frame coordinates and notify its part via Part::DragEnter(). The dispatcher will only make this call if the facet's frame's "isDroppable" flag is set. Inputs point The location in window coordinates the mouse entered this facet. dragInfo The items being dragged. biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::DragLeave Facet::DragLeave Facet->DragLeave æT Class Method æD void DragLeave( ODPoint point, ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Finish a drag operation in the facet. The facet will transform the point into frame coordinates and notify its part via Part::DragLeave(). The dispatcher will only make this call if the facet's frame's "isDroppable" flag is set. Inputs point The location in window coordinates where the mouse left the facet. biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::DragWithin Facet::DragWithin Facet->DragWithin æT Class Method æD void DragWithin( ODPoint point, ODDragItemIterator* dragInfo, ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Continue a drag operation in the facet. The facet will transform the point into frame coordinates and notify its part via Part::DragWithin(). The dispatcher will only make this call if the facet's frame's "isDroppable" flag is set. Inputs point The location of the mouse in window coordinates. dragInfo The items being dragged. biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::Draw Facet::Draw Facet->Draw æT Class Method æD void Draw( ODShape* invalidShape, ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Tell the facet's part to draw itself in invalidShape in this facet. The facet transforms invalidShape into frame coordinates, and passes the request to the part via Part::Draw(). Inputs invalidShape The area in which the part should draw itself. In window coordinates. biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::DrawActiveBorder Facet::DrawActiveBorder Facet->DrawActiveBorder æT Class Method æD void DrawActiveBorder(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Draw the facet's active border adornment. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::DrawChildren Facet::DrawChildren Facet->DrawChildren æT Class Method æD void DrawChildren( ODShape* invalidShape, ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Draw all this facet's child facets which need updating. Inputs invalidShape The shape in which the facets should draw. biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::DrawChildrenAlways Facet::DrawChildrenAlways Facet->DrawChildrenAlways æT Class Method æD void DrawChildrenAlways( ODShape* invalidShape, ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Draw all this facet's child facets, whether they need updating or not. Inputs invalidShape The shape in which the facets should draw. biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::DrawnIn Facet::DrawnIn Facet->DrawnIn æT Class Method æD void DrawnIn( ODShape* shape, ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Notify the facet it has been drawn in via another path than an update operation. Notify the owner of the facet's canvas to update its parent canvas with the altered contents. Inputs shape The shape in which the facet has been drawn. In frame coordinates. biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::Drop Facet::Drop Facet->Drop æT Class Method æD ODDropResult Drop( ODPoint point, ODDragItemIterator* dropInfo, ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Drop items into the facet. The facet will transform the point into frame coordinates and notify its part via Part::Drop(). The dispatcher will only make this call if the facet's frame's "isDroppable" flag is set. Inputs point The location of the mouse in window coordinates. dropInfo The items being dropped. biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::GetActiveShape Facet::GetActiveShape Facet->GetActiveShape æT Class Method æD ODShape* GetActiveShape( ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the facet's active shape. If none has been set, return its frame's frame shape. Inputs biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs <return> The facet's active shape. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::GetAggregateClipShape Facet::GetAggregateClipShape Facet->GetAggregateClipShape æT Class Method æD ODShape* GetAggregateClipShape( ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the shape which is the intersection of this facet's clip shape, and all containing facets' clip shapes on this facet's canvas. Inputs biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs <return> The facet's aggregate clip shape. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::GetCanvas Facet::GetCanvas Facet->GetCanvas æT Class Method æD ODCanvas* GetCanvas(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the canvas this facet's part should image on. If the facet has no canvas of its own, it will return its containing facet's canvas, recursively. Inputs None. Outputs <return> The facet's canvas. Exceptions Signalled kODErrInvalidCanvas Neither this facet or any of its parents had a canvas. Pre conditions None. Post conditions None. æKY ODFacet::GetClipShape Facet::GetClipShape Facet->GetClipShape æT Class Method æD ODShape* GetClipShape( ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the clip shape of the receiver. Inputs biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs <return> The facet's clip shape. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::GetContainingFacet Facet::GetContainingFacet Facet->GetContainingFacet æT Class Method æD ODFacet* GetContainingFacet(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the containing facet of the receiver. Inputs None. Outputs <return> The containing facet of the receiver. May be kODNULL. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::GetContentTransform Facet::GetContentTransform Facet->GetContentTransform æT Class Method æD ODTransform* GetContentTransform( ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Calculate and return the facet's content transform. This transform is calculated by concatenating the facet's frame's internal transform with this facet's frame transform. This results in a transformation which describes the content coordinate space of this facet on its canvas. Inputs biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs <return> The facet's content transform. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::GetExternalTransform Facet::GetExternalTransform Facet->GetExternalTransform æT Class Method æD ODTransform* GetExternalTransform( ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the external transform of the facet. Inputs biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs <return> The facet's external transform. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::GetFrame Facet::GetFrame Facet->GetFrame æT Class Method æD ODFrame* GetFrame(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the frame this facet displays. Inputs None. Outputs <return> The facet's frame. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::GetFrameTransform Facet::GetFrameTransform Facet->GetFrameTransform æT Class Method æD ODTransform* GetFrameTransform( ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Calculate and return the facet's frame transform. This transform is calculated by concatenating the facet's external transform with all enclosing facets' internal and external transforms, up to the internal transform of the topmost facet on this facet's canvas. This results in a transformation which describes the frame coordinate space of this facet on its canvas. Inputs biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs <return> The facet's frame transform. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::GetHighlight Facet::GetHighlight Facet->GetHighlight æT Class Method æD ODHighlight GetHighlight(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the highlight state of the facet. The facet's part should use this information to draw its contents consistently with the selection highlighting in its containing part. Inputs None. Outputs <return> The highlight state of the facet. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::GetNode Facet::GetNode Facet->GetNode æT Class Method æD FacetNode* GetNode(); æC Protection Protected. Only called by facets. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation None. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::GetPartInfo Facet::GetPartInfo Facet->GetPartInfo æT Class Method æD ODInfoType GetPartInfo(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the partInfo data a part has stored in this facet. Inputs None. Outputs <return> The facet's partInfo. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::GetWindow Facet::GetWindow Facet->GetWindow æT Class Method æD ODWindow* GetWindow(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the window this facet is displayed in. This value may be kODNULL if the facet is a printing facet and does not appear in any window. Inputs None. Outputs <return> The facet's window. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::GetWindowAggregateClipShape Facet::GetWindowAggregateClipShape Facet->GetWindowAggregateClipShape æT Class Method æD ODShape* GetWindowAggregateClipShape( ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the shape which is the intersection of this facet's clip shape, and all containing facets' clip shapes in this facet's window. Inputs biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs <return> The facet's aggregate clip shape. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::GetWindowContentTransform Facet::GetWindowContentTransform Facet->GetWindowContentTransform æT Class Method æD ODTransform* GetWindowContentTransform( ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Calculate and return the facet's window content transform. This transform is calculated by concatenating the facet's frame's internal transform with its window frame transform. This results in a transformation which describes the content coordinate space of this facet in its window. Inputs biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs <return> The facet's window content transform. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::GetWindowFrameTransform Facet::GetWindowFrameTransform Facet->GetWindowFrameTransform æT Class Method æD ODTransform* GetWindowFrameTransform( ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Calculate and return the facet's window frame transform. This transform is calculated by concatenating the facet's external transform with all enclosing facets' internal and external transforms. This results in a transformation which describes the frame coordinate space of this facet in its window. Inputs biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs <return> The facet's window frame transform. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::HasCanvas Facet::HasCanvas Facet->HasCanvas æT Class Method æD ODBoolean HasCanvas(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return whether this facets has its own canvas. Inputs None. Outputs <return> True if the facet has its own canvas, or false if not. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::InitChildFacet Facet::InitChildFacet Facet->InitChildFacet æT Class Method æD void InitChildFacet( FacetNode* node, ODFrame* frame, ODShape* clipShape, ODTransform* externalTransform, ODCanvas* canvas, ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class must override. Derived class must call base class behavior, before derived class behavior. Basic operation Initialize a newly constructed facet. This MUST be called before the facet can be used. Inputs frame The facet's frame. This value never changes over the life of the facet. clipShape The initial clipShape of the facet. externalTransform The initial externalTransform of the facet. canvas The canvas this facet should draw on. May be kODNULL if same as that of containing facet. biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. node The node to which the facet should attach itself. Outputs None. Exceptions Signalled None. Pre conditions Facet is newly constructed. Post conditions Facet can be used for display or event dispatching. æKY ODFacet::InitFacet Facet::InitFacet Facet->InitFacet æT Class Method æD void InitFacet( ODFrame* frame, ODShape* clipShape, ODTransform* externalTransform, ODCanvas* canvas, ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Initialize a newly constructed facet. This MUST be called before the facet can be used. Inputs frame The facet's frame. This value never changes over the life of the facet. clipShape The initial clipShape of the facet. externalTransform The initial externalTransform of the facet. canvas The canvas this facet should draw on. May be kODNULL if same as that of containing facet. biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs None. Exceptions Signalled None. Pre conditions Facet is newly constructed. Post conditions Facet can be used for display or event dispatching. æKY ODFacet::InternalTransformChanged Facet::InternalTransformChanged Facet->InternalTransformChanged æT Class Method æD void InternalTransformChanged(); æC Protection Protected. Only called by frames. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Notify the facet that its frame's internal transform has been changed. If facets are caching aggregate transformation information, this should notify child facets to invalidate those caches. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::Invalidate Facet::Invalidate Facet->Invalidate æT Class Method æD void Invalidate( ODShape* invalidShape, ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Cause the underlying graphics system to mark the area in invalidShape as needing repainting. This area is marked on this facet's canvas, and all parent canvases, so changes in this facet can be reflected in those canvases. Inputs invalidShape The area to mark as invalid. In frame coordinates. biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs None. Exceptions Signalled kODErrInvalidFacet Can't find facet for parent canvas. Pre conditions None. Post conditions None. æKY ODFacet::InvalidateActiveBorder Facet::InvalidateActiveBorder Facet->InvalidateActiveBorder æT Class Method æD void InvalidateActiveBorder(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Mark the area under the facet's active border adornment as needing redrawing. This can be used to erase the active border. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::InvalidateAggregateClipShape Facet::InvalidateAggregateClipShape Facet->InvalidateAggregateClipShape æT Class Method æD void InvalidateAggregateClipShape(); æC Protection Protected. Only called by other facets in Mac implementation. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation None. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::InvalidateAggregateTransforms Facet::InvalidateAggregateTransforms Facet->InvalidateAggregateTransforms æT Class Method æD void InvalidateAggregateTransforms(); æC Protection Protected. Only called by facets. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation None. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::IsSelected Facet::IsSelected Facet->IsSelected æT Class Method æD ODBoolean IsSelected(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the facet's isSelected flag. Indicates whether the facet is selected within its container. This information is used by the dispatcher to determine where to send mouse events. Inputs None. Outputs <return> Value of the facet's isSelected flag. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::MouseEnter Facet::MouseEnter Facet->MouseEnter æT Class Method æD void MouseEnter( ODPoint where, ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation The mouse has entered the facet's active shape. Transform the mouse location to frame coordinates, and pass to the part via Part::MouseEnter(). Inputs where The mouse location. In window coordinates. biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::MouseLeave Facet::MouseLeave Facet->MouseLeave æT Class Method æD void MouseLeave(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation The mouse has left the facet's active shape. Pass to the part via Part::MouseLeave(). Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::MouseWithin Facet::MouseWithin Facet->MouseWithin æT Class Method æD void MouseWithin( ODPoint where, ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation The mouse has moved within the facet's active shape. Transform the mouse location to frame coordinates, and pass to the part via Part::MouseWithin(). Inputs where The mouse location. In window coordinates. biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::MoveBefore Facet::MoveBefore Facet->MoveBefore æT Class Method æD void MoveBefore( ODFacet* child, ODFacet* sibling); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Move one of a facet's child facets in front of a sibling facet. Inputs child The child facet to reposition. sibling The facet to move "child" in front of. If the value is kODNULL, "child" is moved to the front of all its siblings. Outputs None. Exceptions Signalled kODErrInvalidFacet "child" or "sibling" is not a valid child facet of the receiver. Pre conditions "child" and "sibling" are both chldren of the receiver. Post conditions "child" has been repositioned in front of "sibling" or all siblings. æKY ODFacet::MoveBehind Facet::MoveBehind Facet->MoveBehind æT Class Method æD void MoveBehind( ODFacet* child, ODFacet* sibling); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Move one of a facet's child facets behind a sibling facet. Inputs child The child facet to reposition. sibling The facet to move "child" behind. If the value is kODNULL, "child" is moved behind all its siblings. Outputs None. Exceptions Signalled kODErrInvalidFacet "child" or "sibling" is not a valid child facet of the receiver. Pre conditions "child" and "sibling" are both chldren of the receiver. Post conditions "child" has been repositioned behind "sibling" or all siblings. æKY ODFacet::NeedsUpdate Facet::NeedsUpdate Facet->NeedsUpdate æT Class Method æD ODBoolean NeedsUpdate(); æC Protection Protected. Only called by facets. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation None. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::Purge Facet::Purge Facet->Purge æT Class Method æD ODSize Purge( ODSize size); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Attempt to free up to "size" bytes of memory by releasing non-essential internal resources. Inputs size The number of bytes to attempt to free. Outputs <return> The number of bytes actually freed. Exceptions Signalled None. Pre conditions None. Post conditions Facet has released some non-essential internal resources. æKY ODFacet::RemoveFacet Facet::RemoveFacet Facet->RemoveFacet æT Class Method æD void RemoveFacet( ODFacet* facet); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Asks a facet to remove one of its child facets. This request should be made by a facet's part prior to removing one of its embedded frames, or optionally when scrolling an embedded frame out of view. The removed facet's part will be notified that a facet has been removed from its frame [ODPart::FacetRemoved(facet)]. The caller should then delete the removed facet. Inputs facet The child facet to remove. Outputs None. Exceptions Signalled kODErrInvalidFacet "facet" is not a child of the receiver. Pre conditions "facet" must be a child of the receiver. Post conditions "facet" should not be used again. Ready to be deleted by the caller. æKY ODFacet::SetCanvas Facet::SetCanvas Facet->SetCanvas æT Class Method æD void SetCanvas( ODCanvas* canvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Set the canvas of this facet. After this operation, this facet and its children should image on that canvas. Mac only: The facet does NOT assume responsibility for deallocating the canvas' storage. Inputs canvas The new canvas. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::SetNeedsUpdate Facet::SetNeedsUpdate Facet->SetNeedsUpdate æT Class Method æD void SetNeedsUpdate( ODBoolean needsUpdate); æC Protection Protected. Only called by facets. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation None. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::SetPartInfo Facet::SetPartInfo Facet->SetPartInfo æT Class Method æD void SetPartInfo( ODInfoType partInfo); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Set the partInfo data for this facet. PartInfo should only be set by a facet's part. Inputs partInfo The new partInfo for this facet. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::SetSelected Facet::SetSelected Facet->SetSelected æT Class Method æD void SetSelected( ODBoolean isSelected); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Set the facet's isSelected flag. Inputs isSelected The new value of the flag. True if the facet is selected within its containing part. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::Update Facet::Update Facet->Update æT Class Method æD void Update( ODShape* invalidShape, ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Update the facet's canvas in the invalidShape by drawing this facet and any of its children whose clipShape intersects invalidShape. Inputs invalidShape The shape in which the facet's canvas must be repainted. In window coordinates. biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::Validate Facet::Validate Facet->Validate æT Class Method æD void Validate( ODShape* validShape, ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Cause the underlying graphics system to mark the area in validShape as no longer needing repainting. Inputs validShape The shape to mark as valid. In frame coordinates. biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacet::fActiveShape Facet::fActiveShape æT Class Field æD ODShape* æC æKY ODFacet::fAggregateClipShape Facet::fAggregateClipShape æT Class Field æD ODShape* æC æKY ODFacet::fCanvas Facet::fCanvas æT Class Field æD ODCanvas* æC æKY ODFacet::fClipShape Facet::fClipShape æT Class Field æD ODShape* æC æKY ODFacet::fContentTransform Facet::fContentTransform æT Class Field æD ODTransform* æC æKY ODFacet::fExternalTransform Facet::fExternalTransform æT Class Field æD ODTransform* æC æKY ODFacet::fFrame Facet::fFrame æT Class Field æD ODFrame* æC æKY ODFacet::fFrameTransform Facet::fFrameTransform æT Class Field æD ODTransform* æC æKY ODFacet::fHighlight Facet::fHighlight æT Class Field æD ODHighlight æC æKY ODFacet::fIsSelected Facet::fIsSelected æT Class Field æD ODBoolean æC æKY ODFacet::fNeedsUpdate Facet::fNeedsUpdate æT Class Field æD ODBoolean æC æKY ODFacet::fNode Facet::fNode æT Class Field æD FacetNode* æC æKY ODFacet::fPartInfo Facet::fPartInfo æT Class Field æD ODInfoType æC æKY ODFacet::fWindowAggregateClipShape Facet::fWindowAggregateClipShape æT Class Field æD ODShape* æC æKY ODFacet::fWindowContentTransform Facet::fWindowContentTransform æT Class Field æD ODTransform* æC æKY ODFacet::fWindowFrameTransform Facet::fWindowFrameTransform æT Class Field æD ODTransform* æC æKY ODFacetIteratorHelp ODFacetIterator FacetIterator æKL ODFacetIterator::ODFacetIterator ODFacetIterator::~ODFacetIterator ODFacetIterator::First ODFacetIterator::IsNotComplete ODFacetIterator::Next ODFacetIterator::SkipChildren æC Basic Class Documentation Ancestors: none ODFacetIterator is a companion to class ODFacet. It allows iteration of all the children of a facet. Parts, container applications, or other classes may need to iterate facets. All can instatiate this class. There are three ways to use an ODFacetIterator, depending on the traversalType specified when the iterator is created. kODTopDown starts with the specified facet, and walks depth-first down the sub-tree from that as the root. kODBottomUp starts at the leftmost leaf, and walks depth-first up the tree to the root. kODChildrenOnly simply iterates only the direct children of the specified facet. In a top-down traversal, the method SkipChildren() can be used to advance the next item to skip over the current item's children. Theory of Operation Invariants Maintained by Class æKY ODFacetIterator::ODFacetIterator FacetIterator::ODFacetIterator FacetIterator->ODFacetIterator æT Class Method æD ODFacetIterator( ODFacet* facet, ODTraversalType traversalType, ODSiblingOrder siblingOrder); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Construct an iterator on facet and its child facets. Inputs facet Root of the sub-tree of facets the iterator will traverse. traversalType kODTopDown: start at "facet" and walk down depth-first. kODBottomUp: start at bottom of tree and walk up to root. kODChildrenOnly: only the direct children of "facet". siblingOrder kODFrontToBack, kODBackToFront Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacetIterator::~ODFacetIterator FacetIterator::~ODFacetIterator FacetIterator->~ODFacetIterator æT Class Method æD ~ODFacetIterator(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Destructor. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacetIterator::First FacetIterator::First FacetIterator->First æT Class Method æD ODFacet* First(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the first facet specified by the traversalType and siblingOrder of this iterator. Inputs None. Outputs <return> The first facet in the sequence. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacetIterator::IsNotComplete FacetIterator::IsNotComplete FacetIterator->IsNotComplete æT Class Method æD ODBoolean IsNotComplete(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return whether the last item returned from First() or Next() was valid. Inputs None. Outputs <return> True if iterator is not yet complete, false otherwise. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacetIterator::Next FacetIterator::Next FacetIterator->Next æT Class Method æD ODFacet* Next(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Answer the next facet in the sequence. Inputs None. Outputs <return> The next facet. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFacetIterator::SkipChildren FacetIterator::SkipChildren FacetIterator->SkipChildren æT Class Method æD void SkipChildren(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation If traversalType is kODTopDown, this causes the sequence to skip any children of the current item, if any. For other traversal types, it has no effect. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFocusModuleHelp ODFocusModule FocusModule æKL ODFocusModule::ODFocusModule ODFocusModule::~ODFocusModule ODFocusModule::AbortRelingquishFocus ODFocusModule::BeginRelinquishFocus ODFocusModule::CommitRelinquishFocus ODFocusModule::CreateOwnerIterator ODFocusModule::GetFocusOwner ODFocusModule::InitFocusModule ODFocusModule::IsFocusExclusive ODFocusModule::SetFocusOwnership ODFocusModule::TransferFocusOwnership ODFocusModule::UnsetFocusOwnership ODFocusModule::fSession æC Basic Class Documentation ODFocusModule is an abstract base class for focus modules, which are the means of extensibility used by the arbitrator. The arbitrator maintains a table of focus modules indexed by focus type. ODFocusModule has no base class. ODFocusModule is implemented by the platform vendor. Related classes are ODArbitrator, ODFocusSet and ODFocusSetIterator. Theory of Operation Instances of ODFocusModule are registered with the arbitrator, and associated with one or more focus types. See ODArbitrator. Invariants Maintained by Class Stores the owner frame for one or more foci. æKY ODFocusModule::ODFocusModule FocusModule::ODFocusModule FocusModule->ODFocusModule æT Class Method æD ODFocusModule(); æC Protection Public. Parts and container apps would typically only create focus modules that they temselves define. Override policy Derived class cannot override. Derived class cannot call base class behavior, before derived class behavior. Basic operation Constructs a focus module. The InitFocusModule method must also be called. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions The object is constructed, but not ready for use until InitFocusModule is called. æKY ODFocusModule::~ODFocusModule FocusModule::~ODFocusModule FocusModule->~ODFocusModule æT Class Method æD ~ODFocusModule(); æC Protection Public. The arbitrator deletes installed focus modules. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Frees the memory allocated by this object. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions A valid instance. Post conditions The memory used by this object is freed. æKY ODFocusModule::AbortRelingquishFocus FocusModule::AbortRelingquishFocus FocusModule->AbortRelingquishFocus æT Class Method æD void AbortRelinquishFocus( ODTypeToken focus, ODFrame* requestingFrame); æC Protection Public. Called only by ODArbitrator. Part Editors call ODArbitrator methods.Implementors of focus modules need not override this method. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Implementation detail. Inputs focus A token for a focus requestingFrame The new owner of the focus Outputs None. Exceptions Signalled None. Pre conditions A valid focus and frame. BeginRelinquishFocus returned kODFalse for one of the elements of the requested focus set. Post conditions The owner part has undone any changes it made when asked toBeginRelinquishFocus(). æKY ODFocusModule::BeginRelinquishFocus FocusModule::BeginRelinquishFocus FocusModule->BeginRelinquishFocus æT Class Method æD ODBoolean BeginRelinquishFocus( ODTypeToken focus, ODFrame* requestingFrame); æC Protection Public. Called only by ODArbitrator. Part Editors call ODArbitrator methods. Implementors of focus modules need not override this method. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Implementation detail. Inputs focus A token for a focus requestingFrame The potential new owner frame of the focus. Outputs <return> kODTrue if the current owner is willing to give up ownership. Exceptions Signalled None. Pre conditions A valid focus, and frame. Post conditions The function result expresses the current owner's willingness to relinquish the focus. æKY ODFocusModule::CommitRelinquishFocus FocusModule::CommitRelinquishFocus FocusModule->CommitRelinquishFocus æT Class Method æD void CommitRelinquishFocus( ODTypeToken focus, ODFrame* requestingFrame); æC Protection Public. Called only by ODArbitrator. Part Editors call ODArbitrator methods.Implementors of focus modules need not override this method. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Implementation detail Inputs focus A token for a focus requestingFrame The new owner of the focus. Outputs None. Exceptions Signalled None. Pre conditions A valid focus and frame.BeginRelinquishFocus was called with the same focus, and returned kODTrue. Post conditions Part-dependent. æKY ODFocusModule::CreateOwnerIterator FocusModule::CreateOwnerIterator FocusModule->CreateOwnerIterator æT Class Method æD ODFocusOwnerIterator* CreateOwnerIterator( ODTypeToken focus); æC Protection Public. Called by ODArbitrator. Part Editors call ODArbitrator methods. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns an iterator for the owners of a non-exclusive focus. The caller must delete the iterator. Inputs focus Atoken for a focus Outputs <return> The iterator Exceptions Signalled None. Pre conditions A valid focus. Post conditions Result contains new iterator. æKY ODFocusModule::GetFocusOwner FocusModule::GetFocusOwner FocusModule->GetFocusOwner æT Class Method æD ODFrame* GetFocusOwner( ODTypeToken focus); æC Protection Public. Called by ODArbitrator. Part Editors call ODArbitrator::GetFocusOwner. Override policy Derived class must override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the current owner frame for the specified focus. Inputs focus A token for a focus Outputs <return> The owner frame Exceptions Signalled None. Pre conditions A valid focus. Post conditions The owner frame is returned. æKY ODFocusModule::InitFocusModule FocusModule::InitFocusModule FocusModule->InitFocusModule æT Class Method æD void InitFocusModule( ODSession* session); æC Protection Public. Parts and container apps would typically only create focus modules that they temselves define. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Initializes the focus module. Inputs session The OpenDoc session object. Outputs None. Exceptions Signalled None. Pre conditions A constructed instance. Post conditions An initialize and usable instance. æKY ODFocusModule::IsFocusExclusive FocusModule::IsFocusExclusive FocusModule->IsFocusExclusive æT Class Method æD ODBoolean IsFocusExclusive( ODTypeToken focus); æC Protection Public. Called by Arbitrator. Can be called by parts. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns kODTrue if the specified focus is exclusive Inputs focus A token for a registered focus. Outputs <return> kODTrue if the specified focus is exclusive, kODFalse otherwise. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions No effect on internal state. æKY ODFocusModule::SetFocusOwnership FocusModule::SetFocusOwnership FocusModule->SetFocusOwnership æT Class Method æD void SetFocusOwnership( ODTypeToken focus, ODFrame* frame); æC Protection Public. Called by ODArbitrator. Part Editors call ODArbitrator methods. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Stores the frame as the owner of the specified focus. If this focus module manages more than one focus, a table must be maintained. Inputs focus A token for a focus frame The new owner frame Outputs None. Exceptions Signalled kODErrInvalidFrame The specified frame is invalid Pre conditions A valid focus, and frame. Post conditions Ownership is stored. æKY ODFocusModule::TransferFocusOwnership FocusModule::TransferFocusOwnership FocusModule->TransferFocusOwnership æT Class Method æD void TransferFocusOwnership( ODTypeToken focus, ODFrame* frame); æC Protection Public. Called by ODArbitrator. Part Editors call ODArbitrator methods. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Transfers ownership of the focus to the new frame. Inputs focus A token for a focus frame The new owner frame Outputs None. Exceptions Signalled kODErrInvalidFrame The specified frame is invalid Pre conditions None. Post conditions None. æKY ODFocusModule::UnsetFocusOwnership FocusModule::UnsetFocusOwnership FocusModule->UnsetFocusOwnership æT Class Method æD void UnsetFocusOwnership( ODTypeToken focus, ODFrame* frame); æC Protection Public. Called by ODArbitrator. Part Editors call ODArbitrator methods. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Store kODNULL as the owner of the specified focus. Inputs focus A token for a focus frame The current owner of the focus Outputs None. Exceptions Signalled kODErrInvalidFrame The specified frame is invalid Pre conditions A valid focus, and frame. Post conditions Ownership is removed. æKY ODFocusModule::fSession FocusModule::fSession æT Class Field æD ODSession* fSession; æC æKY ODFocusOwnerIteratorHelp ODFocusOwnerIterator FocusOwnerIterator æKL ODFocusOwnerIterator::ODFocusOwnerIterator ODFocusOwnerIterator::~ODFocusOwnerIterator ODFocusOwnerIterator::First ODFocusOwnerIterator::InitFocusOwnerIterator ODFocusOwnerIterator::IsNotComplete ODFocusOwnerIterator::Next ODFocusOwnerIterator::fFocus ODFocusOwnerIterator::fFocusModule æC Basic Class Documentation ODFocusOwnerIterator is an abstract class. Focus modules for non-exclusive foci must implement a subclass of this class. ODFocusOwnerIterator has no base class. Related classes are ODArbitrator and ODFocusModule Theory of Operation ODFocusOwnerIterator allows a dispatch module or other client to iterate over the owners of a non-exclusive focus in a loop, using the iterator's First(), Next() and IsNotComplete() methods. Invariants Maintained by Class The iterator stores a reference to the focus module which stores the list of owners. Subclasses may add additional invariants. æKY ODFocusOwnerIterator::ODFocusOwnerIterator FocusOwnerIterator::ODFocusOwnerIterator FocusOwnerIterator->ODFocusOwnerIterator æT Class Method æD ODFocusOwnerIterator(); æC Protection Public. Part Editors should call ODArbitrator::CreateOwnerIterator(). Implementors of focus modules should provide their owne constructor. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Constructs the iterator. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions Iterator is constructed, but not usable until InitFocusOwnerIterator is called. æKY ODFocusOwnerIterator::~ODFocusOwnerIterator FocusOwnerIterator::~ODFocusOwnerIterator FocusOwnerIterator->~ODFocusOwnerIterator æT Class Method æD ~ODFocusOwnerIterator(); æC Protection Public. Implementors of focus modules should provide their owne destructor. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Frees the memory allocated by this class. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions A constructed and initialized instance. Post conditions The memory used by the instance has been freed. æKY ODFocusOwnerIterator::First FocusOwnerIterator::First FocusOwnerIterator->First æT Class Method æD ODFrame* First(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Should return the first frame which is an owner of this non-exclusive focus. Inputs None. Outputs <return> The first owner frame Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions Internal position is advanced. æKY ODFocusOwnerIterator::InitFocusOwnerIterator FocusOwnerIterator::InitFocusOwnerIterator FocusOwnerIterator->InitFocusOwnerIterator æT Class Method æD void InitFocusOwnerIterator( ODTypeToken focus, ODFocusModule* module); æC Protection Public. Clients should call ODArbitrator::CreateOwnerIterator(). Implementors of focus modules should provide their owne Init method. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Initialize the iterator. Inputs focus A token for a focus module The focus module which stores the owners of a non-exclusive focus. Outputs None. Exceptions Signalled kODErrInvalidFocusModule The specified focus module is invalid. Pre conditions A valid focus module for a non-exclusive focus. Post conditions A valid iterator exists. æKY ODFocusOwnerIterator::IsNotComplete FocusOwnerIterator::IsNotComplete FocusOwnerIterator->IsNotComplete æT Class Method æD ODBoolean IsNotComplete(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Should return kODTrue if the iteration is not complete, kODFalse otherwise. Inputs None. Outputs <return> kODTrue if iteration is not complete, kODFalse otherwise. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions No effect on internal state. æKY ODFocusOwnerIterator::Next FocusOwnerIterator::Next FocusOwnerIterator->Next æT Class Method æD ODFrame* Next(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Should return the next owner frame of this non-exclusive focus. Inputs None. Outputs <return> The next owner frame Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions Internal position is advanced. æKY ODFocusOwnerIterator::fFocus FocusOwnerIterator::fFocus æT Class Field æD ODTypeToken fFocus; æC æKY ODFocusOwnerIterator::fFocusModule FocusOwnerIterator::fFocusModule æT Class Field æD ODFocusModule* fFocusModule; æC æKY ODFocusSetHelp ODFocusSet FocusSet æKL ODFocusSet::ODFocusSet ODFocusSet::~ODFocusSet ODFocusSet::Add ODFocusSet::Contains ODFocusSet::CreateIterator ODFocusSet::InitFocusSet ODFocusSet::Remove ODFocusSet::fImplementation æC Basic Class Documentation An ODFocusSet is used to store a set of tokenized focus types. ODFocusSet has no base class. Related classes are ODFocusSetIterator and ODArbitrator. ODFocusSet is platform-independent. ODFocusSet participates in the Part Activation protocol. Theory of Operation A part activates itself by requesting a set of foci from the arbitrator. The ODFocusSet class is used to store the set of foci. The foci are of type ODFocusType (ISO strings) but the elements of the set are tokenized strings (ODTypeToken). The ODSession object contains methods for tokenizing. ODFocusSet has methods for adding and removing foci, and for testing membership. The companion iterator class, ODFocusSetIterator, provides enumeration of the elements of the set. Invariants Maintained by Class An instance of ODFocusSet contains a possibly empty set of foci . No duplicates are allowed. æKY ODFocusSet::ODFocusSet FocusSet::ODFocusSet FocusSet->ODFocusSet æT Class Method æD ODFocusSet(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Constructs the focus set. InitFocusSet must also be called. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions The set is constructed, but not ready for use until InitFocusSet is called. æKY ODFocusSet::~ODFocusSet FocusSet::~ODFocusSet FocusSet->~ODFocusSet æT Class Method æD ~ODFocusSet(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Frees the memory allocated by this object. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions A valid instance. Post conditions The memory used by this object is freed. æKY ODFocusSet::Add FocusSet::Add FocusSet->Add æT Class Method æD void Add( ODTypeToken focus); æC Protection Public. Called by part editors. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Adds the specified focus to the set, if it is not already present. Allocates a collection to store the foci, if necessary. Inputs focus A token for a focus to add to the set. Outputs None Exceptions Signalled kODErrOutOfMemory Pre conditions A constructed object of this class. Post conditions The set contains the new focus. æKY ODFocusSet::Contains FocusSet::Contains FocusSet->Contains æT Class Method æD ODBoolean Contains( ODTypeToken focus); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns kODTrue if the specified focus is an element of the set, kODFalse otherwise. Inputs focus A token for a focus to test for membership Outputs <return> kODTrue, if the set contains the focus, kODFalse otherwise. Exceptions Signalled None. Pre conditions A constructed object of this class. Post conditions The function result contains kODTrue if the specified focus is an element of the set, kODFalse otherwise. æKY ODFocusSet::CreateIterator FocusSet::CreateIterator FocusSet->CreateIterator æT Class Method æD ODFocusSetIterator* CreateIterator(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Creates and returns an iterator for this focus set. The caller is responsible for deleting the iterator. Inputs None. Outputs <return> The iterator Exceptions Signalled None. Pre conditions A constructed object of this class. Post conditions Result contains new iterator. æKY ODFocusSet::InitFocusSet FocusSet::InitFocusSet FocusSet->InitFocusSet æT Class Method æD void InitFocusSet(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Initializes the set. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions A constructed instance. Post conditions Instance is usable. æKY ODFocusSet::Remove FocusSet::Remove FocusSet->Remove æT Class Method æD void Remove( ODTypeToken focus); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Removes the specified focus from the set, if it is present. Inputs focus A token for a focus to remove from the set Outputs None Exceptions Signalled None. Pre conditions A constructed object of this class. Post conditions The specified focus is no longer in the set. æKY ODFocusSet::fImplementation FocusSet::fImplementation æT Class Field æD LinkedList* fImplementation; // For example æC æKY ODFocusSetIteratorHelp ODFocusSetIterator FocusSetIterator æKL ODFocusSetIterator::ODFocusSetIterator ODFocusSetIterator::~ODFocusSetIterator ODFocusSetIterator::First ODFocusSetIterator::InitFocusSetIterator ODFocusSetIterator::IsNotComplete ODFocusSetIterator::Next ODFocusSetIterator::fIterator æC Basic Class Documentation ODFocusSetIterator is a companion of ODFocusSet, used to iterate over the elements of a focus set. ODFocusSetIterator has no base class. ODFocusSetIterator is platform-independent. Related classes are ODArbitrator, ODFocusModule and ODFocusSet. Theory of Operation Given a focus set, ODFocusSetIterator allows the developer to iterate over the set in a loop, using the iterator's First(), Next() and IsNotComplete() methods. Invariants Maintained by Class The iterator contains a reference to the set, or to the underlying collection used to implement the set. The iterator also stores the current element, or a reference to a lower-level collection iterator which contains that state. æKY ODFocusSetIterator::ODFocusSetIterator FocusSetIterator::ODFocusSetIterator FocusSetIterator->ODFocusSetIterator æT Class Method æD ODFocusSetIterator(); æC Protection Public. Clients should call ODFocusSet::CreateIterator Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Sets fields to null values. InitFocusSetIterator must be called. Inputs None. Outputs None Exceptions Signalled None. Pre conditions None. Post conditions The instance is bit ready to use until InitFocusSetIterator is called. æKY ODFocusSetIterator::~ODFocusSetIterator FocusSetIterator::~ODFocusSetIterator FocusSetIterator->~ODFocusSetIterator æT Class Method æD ~ODFocusSetIterator(); æC Protection Public. Parts use delete operator. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Frees memory allocated by this class. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions The memory used by this object is freed. æKY ODFocusSetIterator::First FocusSetIterator::First FocusSetIterator->First æT Class Method æD ODTypeToken First(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Allocates an iterator supplied by the implementation collection class. Resets the iterator to the beginning, returns the first element, and sets it as the current element. Inputs None. Outputs <return> The first focus in the set Exceptions Signalled kODErrOutOfMemory Not enough memory to allocate the LinkedListIterator Pre conditions A constructed object of this class. Post conditions The first element is returned, and the iterator is advanced to be ready to return the next element. æKY ODFocusSetIterator::InitFocusSetIterator FocusSetIterator::InitFocusSetIterator FocusSetIterator->InitFocusSetIterator æT Class Method æD void InitFocusSetIterator( ODFocusSet* focusSet); æC Protection Public. Parts call ODFocusSet::CreateIterator Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Initializes the iterator. Must be calledbefore other methods are called. Inputs focusSet A set of foci over which to iterate Outputs None Exceptions Signalled None. Constructors should not fail. Pre conditions A valid focus set. Post conditions The iterator is constructed, pointing to the first element. æKY ODFocusSetIterator::IsNotComplete FocusSetIterator::IsNotComplete FocusSetIterator->IsNotComplete æT Class Method æD ODBoolean IsNotComplete(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns kODTrue if the iteration is not complete. Inputs None. Outputs <return> kODTrue, if the iteration is not complete. Exceptions Signalled None. Pre conditions A constructed object of this class. Post conditions Result contains kODTrue if the iteration is complete, kODFalse otherwise. æKY ODFocusSetIterator::Next FocusSetIterator::Next FocusSetIterator->Next æT Class Method æD ODTypeToken Next(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the next element of the set. Inputs None. Outputs <return> The next focus in the set Exceptions Signalled None. Pre conditions First has been called. Post conditions Returns the next element. Advances the iterator state to the next element. æKY ODFocusSetIterator::fIterator FocusSetIterator::fIterator æT Class Field æD LinkedListIterator* fIterator; // Private implementation æC æKY ODFrameHelp ODFrame Frame æKL ODFrame::ODFrame ODFrame::~ODFrame ODFrame::ChangeContentExtent ODFrame::ChangeFrameShape ODFrame::ChangeInternalTransform ODFrame::ChangeLinkStatus ODFrame::ChangePart ODFrame::ChangePresentation ODFrame::ChangeUsedShape ODFrame::ChangeViewType ODFrame::CloneTo ODFrame::Close ODFrame::CommonInitFrame ODFrame::ContentChanged ODFrame::CreateFacetIterator ODFrame::CreateShape ODFrame::CreateTransform ODFrame::DoesPropagateEvents ODFrame::DrawActiveBorder ODFrame::EditInLink ODFrame::Externalize ODFrame::FacetAdded ODFrame::FacetRemoved ODFrame::GetContainingFrame ODFrame::GetContentExtent ODFrame::GetFacets ODFrame::GetFrameGroup ODFrame::GetFrameShape ODFrame::GetInternalTransform ODFrame::GetLinkStatus ODFrame::GetPart ODFrame::GetPartInfo ODFrame::GetPresentation ODFrame::GetSequenceNumber ODFrame::GetUsedShape ODFrame::GetViewType ODFrame::GetWindow ODFrame::InitFrame ODFrame::InitFrameFromStorage ODFrame::Invalidate ODFrame::InvalidateActiveBorder ODFrame::IsDragging ODFrame::IsDroppable ODFrame::IsFrozen ODFrame::IsOverlaid ODFrame::IsRoot ODFrame::IsSubframe ODFrame::Purge ODFrame::Release ODFrame::Remove ODFrame::RequestFrameShape ODFrame::SetContainingFrame ODFrame::SetDragging ODFrame::SetDroppable ODFrame::SetFrameGroup ODFrame::SetFrozen ODFrame::SetPartInfo ODFrame::SetPresentation ODFrame::SetPropagateEvents ODFrame::SetSequenceNumber ODFrame::SetSubframe ODFrame::SetViewType ODFrame::SetWindow ODFrame::Validate ODFrame::fContainingFrame ODFrame::fContentExtent ODFrame::fDoesPropagateEvents ODFrame::fFacets ODFrame::fFrameGroup ODFrame::fFrameShape ODFrame::fGettingPart ODFrame::fInternalTransform ODFrame::fIsDragging ODFrame::fIsDroppable ODFrame::fIsFrozen ODFrame::fIsOverlaid ODFrame::fIsRoot ODFrame::fIsSubframe ODFrame::fPart ODFrame::fPartInfo ODFrame::fPresentation ODFrame::fSequenceNumber ODFrame::fUsedShape ODFrame::fViewType ODFrame::fWindow æC Basic Class Documentation Ancestors: ODFrame -> ODPersistentObject -> ODRefCountObject -> ODObject An ODFrame object (along with its facets) describes the geometric boundary between an embedded part and its containing part. A part may be displayed in multiple frames, and each frame represents a particular view of its parts content. Each frame may also appear in a window in multiple places, one for each facet of the frame. Frames are created by containing parts as places to embed other parts. Once a part has been embedded, its frame mediates negotiations between the embedded part and its containing part. Frames maintain a large amount of state information. Some of this data is kept on behalf of the embedded part, some for the containing part, and some small amount for the UI and Imaging subsystems. A frame holds a reference to its containing frame. This will be kODNULL if the frame is the root frame of a window. This value doesn't usually change, but can if the frame was created before it is known where it will be embedded. A frame does not hold direct references to its embedded frames. Only the frame's part knows which frames are embedded in it. A frame also has a list of facets which describe where it is visible in a window. This list may be empty if the frame is scrolled out of view. Since the facet hierarchy is navigable, it is possible to find some of a frame's embedded frames, by asking the frame's facet to iterate its child facets, and thence to their frames. This technique is fine for finding frames which are visible in a window, but it is unreliable for finding all the frames embedded in a frame, as not all may be visible and thus have facets. A frame has two basic shapes which define its geometry. The frameShape is the area the containing part has given to the embedded part. The usedShape is the area the embedded part actually needs. Where appropriate, the containing part will wrap content to the contour of the usedShape. The internalTransform is the third piece of the frame's geometry. It describes how the part's content is scrolled or otherwise transformed within the frame. There are two coordinate systems in the frame to consider. There is the coordinate space of the frame itself, and there is the coordinate space of the frame's content. The internalTransform is the mapping from the content coordinates to the frame coordinates. A frame of course has a reference to its part. The frame ensures that it is added to the part as one of its display frames when it is created, and removed from the part's set of display frames when it is deleted. A frame's part may store arbitrary, uninterpreted data in the frame's partInfo field. Only the part itself interprets or manipulates this data, but the partInfo is stored with the frame, and only internalized when needed for that frame. There are two fields which describe how a part is displayed within a frame. The viewType determines whether the frame is a full frame, an icon, a thumbnail, etc. The presentation describes which kind of view of a part is shown in the frame. Examples are: table, bar chart or pie chart; drawing or palette; text or outline. Part's MUST support all standard viewTypes, but the set of presentations varies from part to part. A containing part may request a particular presentation, but the embedded part need not honor that request. Frame's have a groupID field the containing part may use to group the frames. In cases where a containing part embeds mulitple frames displaying the same part, it may want to group them for group editing, etc. Frames also have a number of flags: isRoot - the frame is the root frame of a window isSubframe - the frame is part of a conglomerate frame (its containing frame displays the same part as the frame itself) isOverlaid - the frame floats about its containing part's other content, and thus need not negotiate for space isFrozen - frozen frames cannot be modified by geometry-based UI events isDroppable - the frame's part supports drag-and-drop events in this frame isDragging - this frame is currently being dragged, don't try to drop items into it or its embedded frames usesCachedImage - the frame displays a static image becuase there is no part editor to display its part doesPropagateEvents - the frame's part delegates unhandled events to its containing part Theory of Operation Invariants Maintained by Class A frame always has a part, and is always a display frame of that part. A frame always has a valid frameShape. The usedShape need not be set, in which case it will default to be the same as the frameShape. A frame always has a valid internalTransform, which defaults to the identity transformation. The isRoot, isSubframe and isOverlaid flags are immutable for the lifetime of the frame. æKY ODFrame::ODFrame Frame::ODFrame Frame->ODFrame æT Class Method æD ODFrame(); æC Protection Protected. Called only by Draft. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Class constructor. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::~ODFrame Frame::~ODFrame Frame->~ODFrame æT Class Method æD ~ODFrame(); æC Protection Protected. Called only by Draft. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Class destructor. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::ChangeContentExtent Frame::ChangeContentExtent Frame->ChangeContentExtent æT Class Method æD void ChangeContentExtent( ODPoint* contentExtent); æC Protection Public. Called by the frame's part. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Set the frame's content extent. For any facets of this frame which own a canvas, update that canvas' biasTransform for the new content size. Inputs contentExtent The new content extent of the frame. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::ChangeFrameShape Frame::ChangeFrameShape Frame->ChangeFrameShape æT Class Method æD void ChangeFrameShape( ODShape* shape, ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Called by containing part to change the frame's frameShape. The frame sets its frameShape field to "shape" and notifies its part of the change via Part::FrameShapeChanged(). Inputs shape The new frameShape. In frame coordinates. biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::ChangeInternalTransform Frame::ChangeInternalTransform Frame->ChangeInternalTransform æT Class Method æD void ChangeInternalTransform( ODTransform* transform, ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Called by the frame's part to change its internalTransform. The frame sets its internalTransform to be "transform", and notifies its facets of the change via Facet::InternalTransformChanged(). Inputs transform The new internalTransform. biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::ChangeLinkStatus Frame::ChangeLinkStatus Frame->ChangeLinkStatus æT Class Method æD void ChangeLinkStatus( ODLinkStatus status); æC Protection Public. Parts call this for any ODFrames that are involved in a link when a link is created, broken, moved, etc. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Set the link status for the frame to the given value. Parts involved in moving or creating frames must set this attribute on frames they own. A frame should then look to its containing frame to see if it should set itself to the requested status or not. It should try to set itself to the net effect of whatever state it’s in. The frame should then call ODPart::LinkStatusChanged to notify the part of the change so that the part may call ODFrame::ChangeLinkStatus for other owned frames and/or embedded frames Inputs None Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions The frame's link status may or may not have changed and frame will call the LinkStatusChanged method of its part. æKY ODFrame::ChangePart Frame::ChangePart Frame->ChangePart æT Class Method æD void ChangePart( ODPart* part); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Remove all of this frame's facets from its old part via Part::FacetRemoved(). Set its part to be "part". Add all its facets to the new part via Part::FacetAdded(). Inputs part The frame's new part. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::ChangePresentation Frame::ChangePresentation Frame->ChangePresentation æT Class Method æD void ChangePresentation( ODTypeToken presentation); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Called by containing part to request the frame to change its presentation. Sets the presentation to "presentation", and notifies the frame's part of the change via Part::PresentationChanged(). If the part does not support the requested presentation, it may then change the presentation again using the Frame::SetPresentation() method. Inputs presentation The frame's presentation. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::ChangeUsedShape Frame::ChangeUsedShape Frame->ChangeUsedShape æT Class Method æD void ChangeUsedShape( ODShape* shape, ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Called by the frame's part to change its usedShape. The frame sets its usedShape to "shape", and notifies its containing part of the change via Part::UsedShapeChanged(). Inputs shape The new usedShape. In frame coordinates. biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::ChangeViewType Frame::ChangeViewType Frame->ChangeViewType æT Class Method æD void ChangeViewType( ODTypeToken viewType); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Called by containing part to request the frame to change its viewType. Sets the viewType to "viewType", and notifies the frame's part of the change via Part::ViewTypeChanged(). If the part does not support the requested viewType, it may then change the viewType again using the Frame::SetViewType() method. Inputs viewType The frame's new viewType. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::CloneTo Frame::CloneTo Frame->CloneTo æT Class Method æD ODStorageUnit* CloneTo( ODDraftKey key, ODDraft* destDraft); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Externalizes this ODFrame object and recursively clones any of its references to other Storage Units or Parts. Note that the actual copying may not be completed until after EndClone is finished. Inputs key ODDraftKey identifying the Clone transaction. destDraft destDraft Outputs <return> ODStorageUnit referring to the Storage Unit to where this Frame is cloned. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::Close Frame::Close Frame->Close æT Class Method æD void Close(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Prepare frame for being removed from its draft, but don't make the removal persistent. This call is used to clean up frames when a document is being closed after its final save. The frame notifies its part it is being closed via Part::CloseDisplayFrame(), then releases its references to its part and its containingFrame. During CloseDisplayFrame(), the frame's part will call this method recursively on its embedded frames. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions Frame has a valid part, and is a display frame of that part. Post conditions Frame makes no references to other frames or parts. æKY ODFrame::CommonInitFrame Frame::CommonInitFrame Frame->CommonInitFrame æT Class Method æD void CommonInitFrame(); æC Protection Private. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation None. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::ContentChanged Frame::ContentChanged Frame->ContentChanged æT Class Method æD void ContentChanged( ODChangeID change); æC Protection Public. Called by the part displayed by this frame object. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Called by the part displayed by the frame object if the frame is affected by a content change in the part. Causes the EmbeddedFrameChanged() method of all containing parts in the frame hierarchy to be called, thru the root part of the window displaying this frame. This method allows a containing part maintaining a source link to be aware when an embedded part has changed, so it can update the link.Parts should avoid calling this at every content change.They can probably call after a reasonable pause and when the part loses the selection focus. Inputs change A unique change ID. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions The EmbeddedFrameChange method of its part will be called. æKY ODFrame::CreateFacetIterator Frame::CreateFacetIterator Frame->CreateFacetIterator æT Class Method æD ODFrameFacetIterator* CreateFacetIterator(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Create an iterator for this frame's facets. Inputs None. Outputs <return> The iterator. Caller assumes storage responsibility. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::CreateShape Frame::CreateShape Frame->CreateShape æT Class Method æD ODShape* CreateShape(); æC Protection Public. Called by parts to create new shape objects. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation This method is called by parts to obtain new shape instances. Inputs None. Outputs <return> The new shape object. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::CreateTransform Frame::CreateTransform Frame->CreateTransform æT Class Method æD ODShape* CreateTransform(); æC Protection Public. Called by parts to create new transform objects. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation This method is called by parts to obtain new transform instances. Inputs None. Outputs <return> The new transform object. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::DoesPropagateEvents Frame::DoesPropagateEvents Frame->DoesPropagateEvents æT Class Method æD ODBoolean DoesPropagateEvents(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return whether this frame delegates unhandled events to its containing frame. Inputs None. Outputs <return> The doesPropagateEvents flag. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::DrawActiveBorder Frame::DrawActiveBorder Frame->DrawActiveBorder æT Class Method æD void DrawActiveBorder(); æC Protection Public. Called by Arbitrator Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Ask frame to draw its active border adornment as needing to be redrawn. The frame forwards the request to all its facets via Facet::DrawActiveBorder(). Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::EditInLink Frame::EditInLink Frame->EditInLink æT Class Method æD ODBoolean EditInLink(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Parts call EditInLink when the user attempts to edit content in a frame embedded in the destination of a link. (Each frame has a link status that indicates the frame's participation in links.) Normally, calling EditInLink causes the containing part that maintains the destination of the link to display an alert giving the user the option of finding the source of the link or breaking the link. In the unusual condition that the part maintaining the destination of the link cannot be found, EditInLink returns kODFalse. In this case, the part should display an alert informing the user that the destinaton of a link cannot be edited. See the corresponding part method EditInLinkAttempted. Inputs None. Outputs <return> kODTrue if the part maintaining the link destination could be contacted, and kODFalse otherwise. Exceptions Signalled None. Pre conditions The link status of this frame is inLinkDestination. Post conditions None. æKY ODFrame::Externalize Frame::Externalize Frame->Externalize æT Class Method æD void Externalize(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Write out the state of this frame onto its storage unit, suitable for subsequent reconstruction of the frame. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions Frame has a valid storage unit. Post conditions None. æKY ODFrame::FacetAdded Frame::FacetAdded Frame->FacetAdded æT Class Method æD void FacetAdded( ODFacet* facet); æC Protection Public. Only called by facet being added. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Notify the frame it has a new facet. The frame adds the facet to its list of facets, and notifies its part of the new facet via Part::FacetAdded(). Inputs facet The new facet. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::FacetRemoved Frame::FacetRemoved Frame->FacetRemoved æT Class Method æD void FacetRemoved( ODFacet* facet); æC Protection Public. Only called by facet. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Notify the frame one of its facets has been removed. The frame removes the facet from its list of facets, and notifies its part via Part::FacetRemoved(). Inputs facet The facet being removed. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::GetContainingFrame Frame::GetContainingFrame Frame->GetContainingFrame æT Class Method æD ODFrame* GetContainingFrame(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the containing frame of this frame. Will return kODNULL if this is a root frame. Inputs None. Outputs <return> This frame's containing frame. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::GetContentExtent Frame::GetContentExtent Frame->GetContentExtent æT Class Method æD ODPoint GetContentExtent(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the content extent of the frame. Inputs None. Outputs <return> The content extent of the frame. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::GetFacets Frame::GetFacets Frame->GetFacets æT Class Method æD OrderedCollection* GetFacets(); æC Protection Protected. Called only by FrameFacetIterator. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation None. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::GetFrameGroup Frame::GetFrameGroup Frame->GetFrameGroup æT Class Method æD ODULong GetFrameGroup(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the groupID of this frame. Inputs None. Outputs <return> The groupID of this frame. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::GetFrameShape Frame::GetFrameShape Frame->GetFrameShape æT Class Method æD ODShape* GetFrameShape( ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return this frame's frameShape. Inputs biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs <return> The frame's frameShape. In frame coordinates. Caller may not alter or delete. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::GetInternalTransform Frame::GetInternalTransform Frame->GetInternalTransform æT Class Method æD ODTransform* GetInternalTransform( ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the internalTransform of the frame. This transform specifies how the content displayed in the frame is transformed relative to the frame's coordinate space. Inputs biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs <return> The frame's internalTransform. Caller may not alter or deallocate. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::GetLinkStatus Frame::GetLinkStatus Frame->GetLinkStatus æT Class Method æD ODLinkStatus GetLinkStatus(); æC Protection Public. Frames will want to call this for their enclosing frames when ChangeLinkStatus is invoked. This will determine how they handle ChangeLinkStatus. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the ODLink status of the frame. Inputs None. Outputs <return> The link status of this frame Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::GetPart Frame::GetPart Frame->GetPart æT Class Method æD ODPart* GetPart(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return this frame's part. Inputs None. Outputs <return> This frame's part. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::GetPartInfo Frame::GetPartInfo Frame->GetPartInfo æT Class Method æD ODInfoType GetPartInfo(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the partInfo data the part has stored in this frame. Inputs None. Outputs <return> The frame's partInfo data. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::GetPresentation Frame::GetPresentation Frame->GetPresentation æT Class Method æD ODTypeToken GetPresentation(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the presentation kind of this frame. Inputs None. Outputs <return> This frame's presentation kind. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::GetSequenceNumber Frame::GetSequenceNumber Frame->GetSequenceNumber æT Class Method æD ODULong GetSequenceNumber(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the sequence number which this frame's containing part has assigned it. Inputs None. Outputs <return> The sequence number of this frame in its frame group. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::GetUsedShape Frame::GetUsedShape Frame->GetUsedShape æT Class Method æD ODShape* GetUsedShape( ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the usedShape of this frame. Inputs biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs <return> The usedShape. In frame coordinates. Caller may not alter or deallocate. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::GetViewType Frame::GetViewType Frame->GetViewType æT Class Method æD ODTypeToken GetViewType(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the viewType of this frame. Inputs None. Outputs <return> The viewType of this frame. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::GetWindow Frame::GetWindow Frame->GetWindow æT Class Method æD ODWindow* GetWindow(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the window in which this frame is displayed. If this frame is a root frame, it will have a reference to its window. If this frame is not a root window, return the root frame's window. If this frame is not in a window (i.e. if being used for printing, not onscreen display), return kODNULL. Inputs None. Outputs <return> The frame's window, or kODNULL. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::InitFrame Frame::InitFrame Frame->InitFrame æT Class Method æD void InitFrame( ODStorageUnit* storageUnit, ODFrame* containingFrame, ODShape* frameShape, ODCanvas* biasCanvas, ODPart* part, ODTypeToken viewType, ODTypeToken presentation, ODBoolean isRoot, ODBoolean isOverlaid); æC Protection Private. Called only by draft. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation None. Inputs storageUnit storageUnit containingFrame containingFrame frameShape frameShape part part viewType viewType presentation presentation isRoot isRoot isOverlaid isOverlaid biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::InitFrameFromStorage Frame::InitFrameFromStorage Frame->InitFrameFromStorage æT Class Method æD void InitFrameFromStorage( ODStorageUnit* storageUnit); æC Protection Private. Called only by Draft. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation None. Inputs storageUnit storageUnit Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::Invalidate Frame::Invalidate Frame->Invalidate æT Class Method æD void Invalidate( ODShape* invalidShape, ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Ask frame to mark "invalidShape" as needing to be redrawn. The frame forwards the request to all its facets via Facet::Invalidate(). Inputs invalidShape The shape to be redrawn. In frame coordinates. biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::InvalidateActiveBorder Frame::InvalidateActiveBorder Frame->InvalidateActiveBorder æT Class Method æD void InvalidateActiveBorder(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Ask frame to mark the shape of its active border adornment as needing to be redrawn. This call is used to erase the active border. The frame forwards the request to all its facets via Facet::InvalidateActiveBorder(). Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::IsDragging Frame::IsDragging Frame->IsDragging æT Class Method æD ODBoolean IsDragging(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return whether this frame is being dragged, so the Dispatcher knows not to drag it into itself or its contents. Inputs None. Outputs <return> The frame's isDragging flag. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::IsDroppable Frame::IsDroppable Frame->IsDroppable æT Class Method æD ODBoolean IsDroppable(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return whether this frame's part supports drag-and-drop. Inputs None. Outputs <return> The frame's isDroppable flag. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::IsFrozen Frame::IsFrozen Frame->IsFrozen æT Class Method æD ODBoolean IsFrozen(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return whether this frame is frozen. Inputs None. Outputs <return> The isFrozen flag of this frame. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::IsOverlaid Frame::IsOverlaid Frame->IsOverlaid æT Class Method æD ODBoolean IsOverlaid(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation None. Inputs None. Outputs <return> The frame's IsOverlaid flag. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::IsRoot Frame::IsRoot Frame->IsRoot æT Class Method æD ODBoolean IsRoot(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation None. Inputs None. Outputs <return> The frame's IsRoot flag. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::IsSubframe Frame::IsSubframe Frame->IsSubframe æT Class Method æD ODBoolean IsSubframe(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation None. Inputs None. Outputs <return> The frame's isSubframe flag. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::Purge Frame::Purge Frame->Purge æT Class Method æD ODSize Purge( ODSize size); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Ask the frame to free up to "size" bytes of memory by releasing non-essential internal data structures. Inputs size The number of bytes to attempt to free. Outputs <return> The number of bytes actually freed. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::Release Frame::Release Frame->Release æT Class Method æD void Release(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Called by another object which had a reference to this frame upon releasing that reference. Decrements the frame's reference count. If there are no more references to the frame, ask the draft to release its storage. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions Frame has a positive reference count. Post conditions None. æKY ODFrame::Remove Frame::Remove Frame->Remove æT Class Method æD void Remove(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Prepare frame for being removed from its draft. The frame notifies its part it is being removed via Part::RemoveDisplayFrame(), then releases its references to its part and its containingFrame. During RemoveDisplayFrame(), the frame's part will call this method recursively on its embedded frames. If the frame's reference count falls to 1, ask the draft to remove the frame. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions Frame has a valid part, and is a display frame of that part. Post conditions Frame makes no references to other frames or parts. Draft may have removed frame. æKY ODFrame::RequestFrameShape Frame::RequestFrameShape Frame->RequestFrameShape æT Class Method æD ODShape* RequestFrameShape( ODShape* shape, ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Called by the frame's part to request a new frameShape. The frame forwards the request (with the shape still in this frame's frame coordinates) to the containing part via Part::RequestFrameShape(). The containing part responds with the shape it will allow the frame to have. The frame stores this shape as its new frameShape, and returns it to the part so the part knows what its new shape is. Inputs shape The requested shape. In frame coordinates. biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs <return> The new frameShape. In frame coordinates. Caller may not alter or deallocate. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::SetContainingFrame Frame::SetContainingFrame Frame->SetContainingFrame æT Class Method æD void SetContainingFrame( ODFrame* frame); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Set the containing frame of this frame. Only necessary if frame is being moved, as will usually be created with correct value. Inputs frame The new containing frame. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::SetDragging Frame::SetDragging Frame->SetDragging æT Class Method æD void SetDragging( ODBoolean isDragging); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Set whether this frame is in process of being dragged. Inputs isDragging The new value for the frame's isDragging flag. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::SetDroppable Frame::SetDroppable Frame->SetDroppable æT Class Method æD void SetDroppable( ODBoolean isDroppable); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Called by the frame's part to indicate whether it supports drag-and-drop in this frame. Inputs isDroppable The new value for this frame's isDroppable flag. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::SetFrameGroup Frame::SetFrameGroup Frame->SetFrameGroup æT Class Method æD void SetFrameGroup( ODULong groupID); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Set the groupID of this frame. This should only be done by the containing part. Inputs groupID The new groupID. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::SetFrozen Frame::SetFrozen Frame->SetFrozen æT Class Method æD void SetFrozen( ODBoolean isFrozen); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Set whether this frame is frozen. Inputs isFrozen The new value for the isFrozen flag. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::SetPartInfo Frame::SetPartInfo Frame->SetPartInfo æT Class Method æD void SetPartInfo( ODInfoType partInfo); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Set the frame's partInfo data. Should only be called by this frame's part. Inputs partInfo The frame's new partInfo. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::SetPresentation Frame::SetPresentation Frame->SetPresentation æT Class Method æD void SetPresentation( ODTypeToken presentation); æC Protection Public. Should only be called by the frame's part. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Set the presentation kind of this frame to "presentation". Should only be called by frame's part. Inputs presentation The frame's presentation kind. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::SetPropagateEvents Frame::SetPropagateEvents Frame->SetPropagateEvents æT Class Method æD void SetPropagateEvents( ODBoolean doesPropagateEvents); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Set whether this frame should delegate unhandled events to its containing frame. Inputs doesPropagateEvents New value for doesPropagateEvents flag. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::SetSequenceNumber Frame::SetSequenceNumber Frame->SetSequenceNumber æT Class Method æD void SetSequenceNumber( ODULong sequenceNumber); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Set the sequence number of this frame. The number should be unique within the frame's group in its containing part. Should only be called by the containing part. Inputs sequenceNumber The new sequence number. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::SetSubframe Frame::SetSubframe Frame->SetSubframe æT Class Method æD void SetSubframe( ODBoolean isSubframe); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Set whether this frame is a subframe of a containing frame. Inputs isSubframe The value for the isSubframe flag. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::SetViewType Frame::SetViewType Frame->SetViewType æT Class Method æD void SetViewType( ODTypeToken viewType); æC Protection Public. Should only be called by frame's part. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Set the viewType of this frame to "viewType". Should only be called by frame's part. Inputs viewType The frame's new viewType. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::SetWindow Frame::SetWindow Frame->SetWindow æT Class Method æD void SetWindow( ODWindow* window); æC Protection Public. Called by the window when it creates this frame as its root frame. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Set the window field of this frame. Only valid for root frames. Inputs window The window for this frame. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::Validate Frame::Validate Frame->Validate æT Class Method æD void Validate( ODShape* validShape, ODCanvas* biasCanvas); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Ask frame to mark "validShape" as no longer needing to be redrawn. The frame forwards the request to all its facets via Facet::Validate(). Inputs validShape The shape which no loger needs to be redrawn. In frame coordinates. biasCanvas The canvas to whose coordinate space the call is biased. May be kODNULL if the geometry is in the standard platform coordinate bias. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrame::fContainingFrame Frame::fContainingFrame æT Class Field æD ODFrame* æC æKY ODFrame::fContentExtent Frame::fContentExtent æT Class Field æD ODPoint fContentExtent; æC æKY ODFrame::fDoesPropagateEvents Frame::fDoesPropagateEvents æT Class Field æD ODBoolean æC æKY ODFrame::fFacets Frame::fFacets æT Class Field æD OrderedCollection* æC æKY ODFrame::fFrameGroup Frame::fFrameGroup æT Class Field æD ODULong æC æKY ODFrame::fFrameShape Frame::fFrameShape æT Class Field æD ODShape* æC æKY ODFrame::fGettingPart Frame::fGettingPart æT Class Field æD ODBoolean æC æKY ODFrame::fInternalTransform Frame::fInternalTransform æT Class Field æD ODTransform* æC æKY ODFrame::fIsDragging Frame::fIsDragging æT Class Field æD ODBoolean æC æKY ODFrame::fIsDroppable Frame::fIsDroppable æT Class Field æD ODBoolean æC æKY ODFrame::fIsFrozen Frame::fIsFrozen æT Class Field æD ODBoolean æC æKY ODFrame::fIsOverlaid Frame::fIsOverlaid æT Class Field æD ODBoolean æC æKY ODFrame::fIsRoot Frame::fIsRoot æT Class Field æD ODBoolean æC æKY ODFrame::fIsSubframe Frame::fIsSubframe æT Class Field æD ODBoolean æC æKY ODFrame::fPart Frame::fPart æT Class Field æD ODPart* æC æKY ODFrame::fPartInfo Frame::fPartInfo æT Class Field æD ODInfoType æC æKY ODFrame::fPresentation Frame::fPresentation æT Class Field æD ODTypeToken æC æKY ODFrame::fSequenceNumber Frame::fSequenceNumber æT Class Field æD ODULong æC æKY ODFrame::fUsedShape Frame::fUsedShape æT Class Field æD ODShape* æC æKY ODFrame::fViewType Frame::fViewType æT Class Field æD ODTypeToken æC æKY ODFrame::fWindow Frame::fWindow æT Class Field æD ODWindow* æC æKY ODFrameFacetIteratorHelp ODFrameFacetIterator FrameFacetIterator æKL ODFrameFacetIterator::ODFrameFacetIterator ODFrameFacetIterator::~ODFrameFacetIterator ODFrameFacetIterator::First ODFrameFacetIterator::IsNotComplete ODFrameFacetIterator::Next æC Basic Class Documentation Ancestors: none ODFrameFacetIterator lists the facets of a frame. Theory of Operation Invariants Maintained by Class æKY ODFrameFacetIterator::ODFrameFacetIterator FrameFacetIterator::ODFrameFacetIterator FrameFacetIterator->ODFrameFacetIterator æT Class Method æD ODFrameFacetIterator( ODFrame* frame); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Construct an iterator on the facets of a frame. Inputs frame The frame who's facets to iterate. Outputs <return> <return> Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrameFacetIterator::~ODFrameFacetIterator FrameFacetIterator::~ODFrameFacetIterator FrameFacetIterator->~ODFrameFacetIterator æT Class Method æD ~ODFrameFacetIterator(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Destructor. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrameFacetIterator::First FrameFacetIterator::First FrameFacetIterator->First æT Class Method æD ODFacet* First(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the first facet of the frame. Inputs None. Outputs <return> The first facet in the sequence. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrameFacetIterator::IsNotComplete FrameFacetIterator::IsNotComplete FrameFacetIterator->IsNotComplete æT Class Method æD ODBoolean IsNotComplete(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return whether the last item returned from First() or Next() was valid. Inputs None. Outputs <return> True if iterator is not yet complete, false otherwise. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODFrameFacetIterator::Next FrameFacetIterator::Next FrameFacetIterator->Next æT Class Method æD ODFacet* Next(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Answer the next facet in the sequence. Inputs None. Outputs <return> The next facet. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODInfoHelp ODInfo Info æKL ODInfo::ShowPartFrameInfo æC Basic Class Documentation The purpose of this class is to provide an API for part developers to show info, or properties about themselves or their embeded parts. Superclass: ODObject Theory of Operation There is only one instance of this class per ODSession. ODSession creates this one instance when initialized and deletes it when deleted. Clients should get this one instance from the session object by calling session->GetInfo() and then making calls onto the returned ODInfo object. Invariants Maintained by Class æKY ODInfo::ShowPartFrameInfo Info::ShowPartFrameInfo Info->ShowPartFrameInfo æT Class Method æD ODBoolean ShowPartFrameInfo( ODFacet* facet); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation This method is to be used in conjuction with the "Part Info" item in the "Edit" menu. The method displays the Part Info dialog centered on the window which the passed in facet is on, and permits the user to make changes to info properties on the facet's frame and that frame's part. Inputs facet The facet passed in is used to determine which window to display the dialog on. The properties displayed in the dialog come from both frame of the facet and the part of that frame. If the caller currently has an embedded frame which is selected that should be frame whose facet is passed in. If no embedded frames are selected, then the caller should pass in a facet of the caller's frame. Outputs <return> If the user clicks OK, then this method returns kODTrue. If the user clicks Cancel, then this method returns kODFalse. Exceptions Signalled None. Pre conditions 'facet' is an ODFacet object of a frame which is selected in the content of the caller or an ODFacet object of a frame of the caller itself. Post conditions Info settings have been updated to reflect what the user chose in the dialog. æKY ODLinkHelp ODLink Link æKL ODLink::ODLink ODLink::~ODLink ODLink::CloneTo ODLink::CreateLinkEdition ODLink::Externalize ODLink::GetChangeTime ODLink::GetContentStorageUnit ODLink::GetLinkEdition ODLink::GetLinkSource ODLink::GetUpdateID ODLink::InitLink ODLink::InitLinkFromStorage ODLink::Lock ODLink::Purge ODLink::RegisterDependent ODLink::ReleaseAll ODLink::SetLinkSource ODLink::ShowLinkDestinationInfo ODLink::ShowSourceContent ODLink::Unlock ODLink::UnregisterDependent ODLink::UpdateLinkEdition ODLink::fLinkSource ODLink::fPartList ODLink::fSection æC Basic Class Documentation This class represents the destinations of an OpenDoc link. Instances of this class will be created and maintained by ODDrafts whenever the user creates a dynamic link between parts. The platform vendor implements this class. This class is not to be subclassed by developers. ODLink is a subclass of ODPersistentObject. For further information on the implementation of OpenDoc links, part developers are referred to the documentation for the companion class ODLinkSource, and the class ODLinkSpec. Specific methods of class ODPart and ODFrame are also relevant to a complete understanding of linking. Document shell developers and platform vendors are referred to the documentation on the ODLinkManager. Theory of Operation A destination part creates a link by grabbing a link specification from the clipboard or drag-and-drop container, and passing that description to its draft's GetLink method. GetLink returns an ODLink object through which the destination retrieves the content of the link. See the description of ODLinkSource for a complete description of the creation of a link. If the destination part wishes to be notified of changes to the link's content, it registers itself with the link object by calling ODLink::RegisterDependent. If the link's content has changed since the part last updated, the link object calls the part's LinkUpdated method to notify the part to read the link data. The part will call ODLink::GetContentStorageUnit to access the data. A destination part's registration with a link is not permanent. Each time a part containing a link destination is initialized, it should re-register with the link object. A destination part may explicitly unregister itself with a link by calling ODLink::UnregisterDependent. This should be performed when the user breaks the link at the destination, for example, or if the linked content is deleted. Invariants Maintained by Class Dependent parts must be maintained in a list for there may be more than one. æKY ODLink::ODLink Link::ODLink Link->ODLink æT Class Method æD ODLink(); æC Protection Public. Should only be called by the ODDraft class. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Initializes data members of the ODLink object to known values. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions The link object is initialized to a known state. æKY ODLink::~ODLink Link::~ODLink Link->~ODLink æT Class Method æD ~ODLink(); æC Protection Public. Should only be called by ODDraft. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Destroys the ODLink object. Inputs None Outputs None Exceptions Signalled None. Pre conditions None. Post conditions There is no more record of this link. æKY ODLink::CloneTo Link::CloneTo Link->CloneTo æT Class Method æD ODStorageUnit* CloneTo( ODDraftKey draftKey, ODDraft* destDraft); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Clone this object into the destination draft. Inputs draftKey ODDraftKey identifying the Clone transaction. destDraft The draft to clone this object into. Outputs <return> The storage unit containing the persistent representation of this object in the destination draft. Exceptions Signalled kODErrCloneNotStarted A Clone was started unsuccessfully. kODErrInvalidDraftKey Invalid Clone. Pre conditions None. Post conditions None. æKY ODLink::CreateLinkEdition Link::CreateLinkEdition Link->CreateLinkEdition æT Class Method æD AliasHandle CreateLinkEdition( EditionContainerSpec editionContainer, ODFileSpec* documentSpec, ODULong sectionID, ODLinkKey key); æC Protection Public. Macintosh specific. Should only be called by the ODLinkManager object. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Create an edition file using the argument container and unique section ID. Inputs editionContainer Specifies the edition file to create. documentSpec The file containing this object's draft. sectionID The section identification to use for this link. key A valid key returned by Lock(). Outputs <result> An alias to the edition file. Exceptions Signalled kODErrInvalidLinkKey Pre conditions The link object does not maintain an edition file. Post conditions The link object maintains the edition file identified by the returned alias. æKY ODLink::Externalize Link::Externalize Link->Externalize æT Class Method æD void Externalize(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Externalizes persistent data Inputs None. Outputs None. Exceptions Signalled <Storage exceptions> Storage exceptions may be signalled. Pre conditions None. Post conditions The link's persistent storage unit is consistent with the link. æKY ODLink::GetChangeTime Link::GetChangeTime Link->GetChangeTime æT Class Method æD time_t GetChangeTime(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the time of the last update to the source of the link. Inputs None. Outputs <return> The time the source of the link was updated. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODLink::GetContentStorageUnit Link::GetContentStorageUnit Link->GetContentStorageUnit æT Class Method æD ODStorageUnit* GetContentStorageUnit( ODLinkKey key); æC Protection Public. No restrictions. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns a reference to the ODStorageUnit containing the content of the link. Inputs key A valid key returned by Lock(). Outputs <result> A reference to the content storage unit. Exceptions Signalled kODErrInvalidLinkKey The key argument is not valid. Pre conditions The key argument is a valid key returned by Lock(). Post conditions The returned storage unit is guaranteed to be valid until the key is relinquished by Unlock(). æKY ODLink::GetLinkEdition Link::GetLinkEdition Link->GetLinkEdition æT Class Method æD AliasHandle GetLinkEdition( ODLinkKey key); æC Protection Public. Macintosh specific. Should only be called by the ODLinkManager object. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation If the link maintains an edition file, return an alias to the file; otherwise, return kODNULL. Inputs key A valid key returned by Lock(). Outputs <result> An edition file alias or kODNULL. Exceptions Signalled kODErrInvalidLinkKey Pre conditions None. Post conditions None. æKY ODLink::GetLinkSource Link::GetLinkSource Link->GetLinkSource æT Class Method æD ODLinkSource* GetLinkSource(); æC Protection Public. For use by container suites only. Not for use by parts or container applications. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the companion ODLinkSource object. Inputs None. Outputs <return> The companion ODLinkSource object. Exceptions Signalled kODErrBrokenLink There is no companion ODLinkSource object for this object. Pre conditions This is an initialized ODLink object. Post conditions None. æKY ODLink::GetUpdateID Link::GetUpdateID Link->GetUpdateID æT Class Method æD ODUpdateID GetUpdateID(); æC Protection Public. Can be used by parts containing a destination of this link to determine if new content is available. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns the current update identification of the link content. This method may be used by destinations to determine if new content is available. Parts can also receive automatic notification of new content by calling the RegisterDependent() method. The returned value should be tested for equality only, as there is no implicit ordering of update ids. Inputs None. Outputs <return> The update identification associated with the current link content. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODLink::InitLink Link::InitLink Link->InitLink æT Class Method æD void InitLink( ODStorageUnit* storageUnit); æC Protection Private. Only called by ODDraft; parts cannot call. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Initializes a new link object. Should be followed by a call to SetLinkSource() after the associated link source object has been initialized. Inputs storageUnit The persistent storage unit for the link. Outputs None. Exceptions Signalled kODErrOutOfMemory Out of memory. Pre conditions None. Post conditions The link object is partially initialized. æKY ODLink::InitLinkFromStorage Link::InitLinkFromStorage Link->InitLinkFromStorage æT Class Method æD void InitLinkFromStorage( ODStorageUnit* storageUnit); æC Protection Public. Only called by ODDraft; parts cannot call. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Internalizes the object from its persistent storage unit. Inputs storageUnit The persistent storage unit for the link object. Outputs None. Exceptions Signalled <Storage exceptions> Exceptions may be raised reading persistent properties. kODLinkBroken The associated link source object could not be found. Pre conditions None. Post conditions The link object is initialized. æKY ODLink::Lock Link::Lock Link->Lock æT Class Method æD ODBoolean Lock( ODULong wait, ODLinkKey* key); æC Protection Public. Parts must call this method to aquire a key required by other methods. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Gain exclusive access to the content storage unit of the link. The value kODTrue is returned if the lock is granted; the key argument is set to a valid link key. Inputs wait The interval to wait for access to be granted. A value of zero means no wait, a value of ULONG_MAX means an indefinite wait. Other values are platform-dependent. Outputs key If the result is kODTrue, a valid key value required by routines that access or modify the link's content. If the result is kODFalse, key is an undefined invalid key. <result> kODTrue if access is granted and kODFalse if denied. Exceptions Signalled None. Pre conditions None. Post conditions If kODTrue is returned, the returned key parameter provides exclusive access to the link's content. æKY ODLink::Purge Link::Purge Link->Purge æT Class Method æD ODSize Purge( ODSize size); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Attempts to free any storage it can. Returns amount it was able to free. Inputs size Amount of memory requested Outputs Return value Amount of memory that was freed Exceptions Signalled None. Pre conditions None. Post conditions Some memory may be freed for use. æKY ODLink::RegisterDependent Link::RegisterDependent Link->RegisterDependent æT Class Method æD void RegisterDependent( ODPart* clientPart, ODUpdateID id); æC Protection Public. Parts containing the destination of this link call this method to receive notification of changes to the link's content. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Puts the clientPart reference on a list for notification of changes to the link's content. Inputs clientPart A destination part wishing to be informed of changes to the contents of the link. id The identification of the last update read from the link. The constant kODUnknownUpdate may be supplied to force notification to read the initial content from the link. The clientPart’s LinkUpdated() method is called immediately if the link’s current update id differs from the argument. Outputs None Exceptions Signalled kODErrOutOfMemory Not enough memory Pre conditions None. Post conditions None. æKY ODLink::ReleaseAll Link::ReleaseAll Link->ReleaseAll æT Class Method æD void ReleaseAll(); æC Protection Public. Should only be called by ODDraft objects. Parts do not call. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Used by the Draft to get the link to release all references to persistent obects. After calling this method, the effect of calling other methods is undefined. The link object should be immediately deleted. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions The link object has been initialized. Post conditions The link object holds no references to other persistent objects. æKY ODLink::SetLinkSource Link::SetLinkSource Link->SetLinkSource æT Class Method æD void SetLinkSource( ODLinkSource* linkSource); æC Protection Public. Only called by ODDraft; parts cannot call. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Completes initialization of this object. Should be called after the argument link source object's InitLinkSource method has been called. Inputs linkSource The associated link source object. Outputs None. Exceptions Signalled None. Pre conditions This link object's InitLink method has been called. Post conditions This link object is completely initialized. æKY ODLink::ShowLinkDestinationInfo Link::ShowLinkDestinationInfo Link->ShowLinkDestinationInfo æT Class Method æD ODBoolean ShowLinkDestinationInfo( ODFacet* facet, ODLinkInfo* info, ODBoolean changesAllowed, ODLinkInfoResult* infoResult); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Display the link dialog showing the information on a destination link. If the return value of this function is kODFalse, that means the user has cancelled out of the dialog and no further action needs to be taken. Otherwise, the caller should examine infoResult and procced accordingly. Inputs facet facet over which the dialog is going to be displayed. info a structure containing the information of the link. changesAllowed If kODTrue, allow the user to change settings in the dialog, otherwise, the dialog is view only. Outputs <return> Boolean showing whether the user hits the OK buttom. infoResult a structure containing the result of the destination link dialog. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODLink::ShowSourceContent Link::ShowSourceContent Link->ShowSourceContent æT Class Method æD void ShowSourceContent(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Causes the source part of the link to become active, makes the source content visible, and displays the link border. Throws an exception if the source part of the link cannot be located, or if the link has been broken at the source. Inputs None. Outputs None. Exceptions Signalled kODErrLinkBroken Cannot locate the source of the link. Pre conditions None. Post conditions None. æKY ODLink::Unlock Link::Unlock Link->Unlock æT Class Method æD void Unlock( ODLinkKey key); æC Protection Public. Parts must call this method when done accessing or modifying the content of a link. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Relinquish a key returned by Lock(). Exclusive access to the link's content by this thread is relinquished if this thread did not already have exclusive access when the key was granted. Inputs key A valid key returned by Lock(). Outputs None. Exceptions Signalled kODErrInvalidLinkKey The key argument is not valid. Pre conditions The key argument is a valid key returned by Lock(). Post conditions The key is no longer valid. Exclusive access to the link's content is relinquished. æKY ODLink::UnregisterDependent Link::UnregisterDependent Link->UnregisterDependent æT Class Method æD void UnregisterDependent( ODPart* clientPart); æC Protection Public. The destination ODPart will call this. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Removes the previously registered ODPart reference from our internal list. Return without error if the part was not previously registered. Inputs clientPart A destination part that had previously registered itself as a dependent of the link. Outputs None Exceptions Signalled None Pre conditions clientPart should have previously registered with this link. Post conditions clientPart is not registered with this link. æKY ODLink::UpdateLinkEdition Link::UpdateLinkEdition Link->UpdateLinkEdition æT Class Method æD void UpdateLinkEdition( ODLinkKey key); æC Protection Public. Macintosh specific. Should only be called by the ODLinkManager object. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Export the link’s contents to destinations in other documents. An exception is thrown if the link does not maintain a cross-document link or if the source is in another document. Inputs key A valid key returned by Lock(). Outputs None. Exceptions Signalled kODErrInvalidLinkKey Pre conditions None. Post conditions None. æKY ODLink::fLinkSource Link::fLinkSource æT Class Field æD ODLinkSource* æC Persistent form OpenDoc:Property:LinkSource kODPropLinkSource A reference to the companion ODLinkSource object. æKY ODLink::fPartList Link::fPartList æT Class Field æD ODPartList* æC Persistent form None. æKY ODLink::fSection Link::fSection æT Class Field æD SectionHandle æC Persistent form OpenDoc:Property:LinkSection kODPropLinkSection The section record for an exported link. æKY ODLinkIteratorHelp ODLinkIterator LinkIterator æKL ODLinkIterator::First ODLinkIterator::InitLinkIterator ODLinkIterator::IsNotComplete ODLinkIterator::Next æC Basic Class Documentation ODLinkIterator is an iterator for the class ODLink. ODLinkIterator is an abstract class with derived from ODObject. Container suites are responsible for subclassing ODLinkIterator to provide the appropriate behavior. The factory method for ODLinkIterator is ODDraft::CreateLinkIterator. This class is not available to parts, but can be used by container applications. Theory of Operation This class is used to iterate over the link objects in a draft. Iteration is forward only, and links are returned in no particular order. After getting the iterator from ODDraft::CreateLinkIterator(), First() should be used to access the first link in the iteration; thereafter, Next() can be called repeatedly to access the remaining links. First() and Next() will return kODNULL when all links have been returned. First() cannot be used to restart the iteration. Invariants Maintained by Class æKY ODLinkIterator::First LinkIterator::First LinkIterator->First æT Class Method æD ODLink First(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns an ODLink object in the draft. The refcount of the object is not incremented. After creating an iterator using ODDraft::CreateLinkIterator, call this method once, then call Next repeatedly to iterate through all links in the draft. Inputs None. Outputs kODErrIteratorOutOfSync The ODTypeList instance was changed during the iteration. Exceptions Signalled None. Pre conditions The iterator was created by ODDraft::CreateLinkIterator. Post conditions A link object is returned, or kODNULL if none exist in the draft. æKY ODLinkIterator::InitLinkIterator LinkIterator::InitLinkIterator LinkIterator->InitLinkIterator æT Class Method æD void InitLinkIterator(); æC Protection Private. For use by factory methods only. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Initializes the iterator. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions First() may be called. æKY ODLinkIterator::IsNotComplete LinkIterator::IsNotComplete LinkIterator->IsNotComplete æT Class Method æD ODBoolean IsNotComplete(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Test if iteration is complete. Inputs None. Outputs <return> Returns kODTrue if the last call to First or Next returned a valid ODLink object, and kODFalse otherwise. Exceptions Signalled None. Pre conditions The list has been created and First() has been called to start the iteration. Post conditions None. æKY ODLinkIterator::Next LinkIterator::Next LinkIterator->Next æT Class Method æD ODLink Next(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns another link object in the draft. Next can be called repeatedly to iterate through the remaining link objects in the draft. IsNotComplete returns kODFalse if the preceeding call to Next did not return a link object. Inputs None. Outputs <return> An ODLink object from the draft. If the iteration is complete kODNULL is returned, although the client should test for completion by calling IsNotComplete. Exceptions Signalled None. Pre conditions First has been called return a link source object in the draft. Post conditions None. æKY ODLinkManagerHelp ODLinkManager LinkManager æKL ODLinkManager::ODLinkManager ODLinkManager::~ODLinkManager ODLinkManager::AnyLinkImported ODLinkManager::CreateLink ODLinkManager::DeleteOnSave ODLinkManager::DraftClosing ODLinkManager::DraftOpened ODLinkManager::DraftSaved ODLinkManager::ExportOnSave ODLinkManager::InitLinkManager ODLinkManager::NewSectionID ODLinkManager::ReserveSectionID ODLinkManager::UnsavedExportedLinks ODLinkManager::fDraftInfos ODLinkManager::fHeap æC Basic Class Documentation The Link Manager coordinates the creation and maintanence of cross-document links. There is one Link Manager object per session. The Link Manager is a non-persistent object instantiated by the session, which provides access to it. The Link Manager is called by link objects, draft objects, and by document shells. It is not visible to parts. Because the implementation of cross-document links is platform-dependent, the Link Manager is a platform-specific class. Document shell developers should understand the following Link Manager methods: AnyLinkImported(), NewSectionID(), ReserveSectionID(), and UnsavedExportedLinks(). In addition, the Link Manager depends on the document shell to call DraftOpened(), DraftSaved(), and DraftClosing() at the proper times. Theory of Operation The Link Manager provides (1) the establishment of cross-document links, (2) the updating of cross-document links in accordance with the user interface guidelines, and (3), on the Macintosh, coordination of use of the Edition Manager with the document shell. It is dependent on the document shell to provide proper updating of cross-document links. When a cross-document link is established, the Link Manager of the destination draft communicates with the Link Manager of the source draft to get the link created. Neither the source nor destination parts are aware that the link is cross-document; this fact is a secret shared by the LinkManager and the Link and LinkSource objects in both drafts. When a draft is opened, the Link Manager ensures that destinations of links from other documents have the opportunity to update to the latest content. It also maintains a list of cross-document link sources that should be updated when the draft is saved. The Link Manager provides coordination of Edition Manager section ids with Macintosh document shells that support Publish and Subscribe. The shell can reserve section ids already in use by calling ReserveSectionID(). The shell can get a new section ID unique for the life of the document by calling NewSectionID(). The Link Manager also provides important information to the document shell. The shell should call AnyLinkImported() when it would otherwise close the document without saving; a return value of kODTrue indicates that links were updated and that the document should be saved without user interaction. When the user closes or reverts a draft without saving, the shell should call UnsavedExportedLinks(); a return value of kODTrue indicates that new cross-document links would be abandoned if the draft isn't saved. Invariants Maintained by Class Other Persistent Properties kODPropReservedSectionIDs -- the list of reserved section identifiers, present in the document properties storage unit. kODPropLastSectionID -- the section identifier last returned by NewSectionID(), present in the document properties storage unit. æKY ODLinkManager::ODLinkManager LinkManager::ODLinkManager LinkManager->ODLinkManager æT Class Method æD ODLinkManager(); æC Protection Public. For use by session objects only. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Constructor for the link manager object. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODLinkManager::~ODLinkManager LinkManager::~ODLinkManager LinkManager->~ODLinkManager æT Class Method æD ~ODLinkManager(); æC Protection Public. For use by session objects only. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Destructor. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODLinkManager::AnyLinkImported LinkManager::AnyLinkImported LinkManager->AnyLinkImported æT Class Method æD ODBoolean AnyLinkImported( ODDraft* draft); æC Protection Public. For use by container apps only. Parts do not call. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns kODTrue if one or more links to source in other documents have automatically updated since the draft was last saved. The shell should silently save the imported content if no other changes to the draft were made by the user. Inputs draft The draft of interest. Outputs <result> kODTrue if one or more links have automatically updated, and kODFalse otherwise. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODLinkManager::CreateLink LinkManager::CreateLink LinkManager->CreateLink æT Class Method æD ODLinkSource* CreateLink( ODDraft* draft, ODLinkSpec* linkSpec); æC Protection Public. For use by draft objects only. Parts do not call. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return a link source object in the argument draft to the source part in another document specified by the link specification argument. The caller must decrement the reference count of the returned link source object when finished with the object. Inputs draft The draft in which the returned link source object should reside. linkSpec The specification for a link whose source part resides in another document. Outputs <result> The link source object created. Exceptions Signalled kODErrDraftNotSaved A link could not be created because the source document has never been saved. Pre conditions None. Post conditions None. æKY ODLinkManager::DeleteOnSave LinkManager::DeleteOnSave LinkManager->DeleteOnSave æT Class Method æD void DeleteOnSave( ODLink* link, ODBoolean doDelete); æC Protection Public. For use by link source objects only. Parts do not call. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation If doDelete is kODTrue, call the DeleteLinkEdition method of the argument link object the next time the draft is saved. If doDelete is kODFalse, do not call DeleteLinkEdition on save. This method should be called by link source objects when the the link is broken. If the draft is closed without saving, or is reverted, the DeleteLinkEdition method will not be called. Inputs link The link object who's DeleteLinkEdition() method should be called when the draft is saved. doDelete If kODTrue, call DeleteLinkEdition the link when the draft is saved; otherwise, do not call on save. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODLinkManager::DraftClosing LinkManager::DraftClosing LinkManager->DraftClosing æT Class Method æD void DraftClosing( ODDraft* draft); æC Protection Public. For use by container apps only. Parts do not call. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Must be called PRIOR to reverting or closing a draft. The link manager will delete any edition files created after the last save, breaking cross-document links at the source. The shell can call UnsavedExportedLinks() to determine if closing the document would delete edition files. Inputs draft The draft about to be closed. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODLinkManager::DraftOpened LinkManager::DraftOpened LinkManager->DraftOpened æT Class Method æD void DraftOpened( ODDraft* draft); æC Protection Public. For use by container apps only. Parts do not call. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Must be called after the argument draft is opened. The link manager will internalize each link object in the draft, allowing those subscribing to or publishing edition files to register with the Edition manager. Inputs draft The draft opened. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODLinkManager::DraftSaved LinkManager::DraftSaved LinkManager->DraftSaved æT Class Method æD void DraftSaved( ODDraft* draft); æC Protection Public. For use by container apps only. Parts do not call. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Must be called after every save. Following each save, links that publish a cross-document link will update their edition file. This method will throw an exception if the edition files cannot be updated; the shell should report this error to the user. The draft should be considered unsaved. The link manager will prohibit this document from publishing a link to another document before the first call to this routine for any draft in the document. A document must be in a permanent location (not a temporary one) in order to reliably track Edition files on the Macintosh. Inputs draft The draft saved. Outputs None. Exceptions Signalled <platform errors> An edition file could not be sucessfully written. Pre conditions None. Post conditions None. æKY ODLinkManager::ExportOnSave LinkManager::ExportOnSave LinkManager->ExportOnSave æT Class Method æD void ExportOnSave( ODLink* link, ODBoolean doExport); æC Protection Public. For use by link objects only. Parts do not call. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation If doExport is kODTrue, call the UpdateLinkEdition method of the argument link object the next time the draft is saved. If doExport is kODFalse, do not call UpdateLinkEdition on save. This method should be called by publishing link objects that export linked data automatically when the draft is saved. If the draft is closed without saving, or is reverted, the Export method will not be called. Once the draft has been saved, the link needs to call this method again when the link is updated. Inputs link The link object who's UpdateLinkEdition() method should be called when the draft is saved. doExport If kODTrue, export the link when the draft is saved; otherwise, do not export on save. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODLinkManager::InitLinkManager LinkManager::InitLinkManager LinkManager->InitLinkManager æT Class Method æD void InitLinkManager( ODSession* session, ODHeap heap); æC Protection Public. For use by session objects only. Override policy Derived class cannot override. Derived class must call base class behavior, during derived class behavior. Basic operation Initializes the link manager. The link manager object should be created and initialized by the session. Inputs session The session context of the link manager. heap The heap for memory allocation. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODLinkManager::NewSectionID LinkManager::NewSectionID LinkManager->NewSectionID æT Class Method æD ODULong NewSectionID( ODDocument* document); æC Protection Public. For use by container apps only. Parts do not call. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Return a new ID guaranteed to be unique for the lifetime of the argument document. Inputs document The document in which to reserve an ID. Outputs <result> A unique ID. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODLinkManager::ReserveSectionID LinkManager::ReserveSectionID LinkManager->ReserveSectionID æT Class Method æD ODBoolean ReserveSectionID( ODULong sectionID, ODDocument* document); æC Protection Public. For use by container apps only. Parts do not call. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Guarantees the argument section ID will not be issued by NewSectionID() for the lifetime of the document. ReserveSectionID returns kODTrue if the argument sectionID is not already reserved and kODFalse otherwise. If kODFalse is returned, the caller should request a different ID or call NewSectionID(). Inputs sectionID The ID to be reserved. document The document in which sectionID is reserved. Outputs <result> kODTrue if the argument sectionID is not in use and not already reserved, and kODFalse otherwise. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODLinkManager::UnsavedExportedLinks LinkManager::UnsavedExportedLinks LinkManager->UnsavedExportedLinks æT Class Method æD ODBoolean UnsavedExportedLinks( ODDraft* draft); æC Protection Public. For use by container apps only. Parts do not call. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns kODTrue if cross-document links have been established since the draft was last saved. Should be called by the document shell prior to reverting or closing the document. If reverting or closing the document would cause newly created cross-document links to be abandoned, the document shell should alert the user before proceeding with the operation. Inputs draft The draft of interest. Outputs <result> kODTrue if cross-document links have been established and kODFalse otherwise. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODLinkManager::fDraftInfos LinkManager::fDraftInfos æT Class Field æD OrderedCollection* æC æKY ODLinkManager::fHeap LinkManager::fHeap æT Class Field æD ODHeap æC æKY ODLinkSourceHelp ODLinkSource LinkSource æKL ODLinkSource::ODLinkSource ODLinkSource::~ODLinkSource ODLinkSource::Clear ODLinkSource::CloneTo ODLinkSource::ContentUpdated ODLinkSource::Externalize ODLinkSource::GetContentStorageUnit ODLinkSource::GetLink ODLinkSource::GetUpdateID ODLinkSource::InitLinkSource ODLinkSource::InitLinkSourceFromStorage ODLinkSource::IsAutoUpdate ODLinkSource::Lock ODLinkSource::Purge ODLinkSource::ReadLinkEdition ODLinkSource::ReleaseAll ODLinkSource::SetAutoUpdate ODLinkSource::SetLink ODLinkSource::SetSourcePart ODLinkSource::ShowLinkSourceInfo ODLinkSource::ShowSourceContent ODLinkSource::Unlock ODLinkSource::UseLinkEdition ODLinkSource::fAutoExport ODLinkSource::fChangeID ODLinkSource::fContentSU ODLinkSource::fLink ODLinkSource::fSection ODLinkSource::fSourcePart æC Basic Class Documentation This class represents the source of an OpenDoc link. These will be created and maintained by ODDrafts whenever the user creates a dynamic link between parts. The platform vendor will implement this class. This class is not to be subclassed by the developer. ODLinkSource is a subclass of ODPersistentObject. For further information on the implementation of OpenDoc links, part developers are referred to the documentation for the companion class ODLink, and the class ODLinkSpec. Specific methods of class ODPart and ODFrame are also relevant to a complete understanding of linking. Document shell developers and platform vendors are referred to the documentation on the ODLinkManager. Theory of Operation A link is a first class, persistent, one-way conduit for data from one part, the source part, to another part, the destination part (which may be the same part). When source part data is being cut or dragged, the source part should write out a link specification (see the ODLinkSpec class) in addition to the content that it writes. The link specification is a signal that a link can be made to the source part. The destination part determines the value types available for linking by examining the value types present in the content property. When a link is requested by the destination part, the following events occur: The destination part asks its draft for an ODLink object via the ODDraft::GetLink method. If the source part is in the same document as the destination part, the draft calls the source part's ODPart::CreateLink method. If the source part is in a different document, the draft calls the link manager's ODLinkManager::CreateLink method to get a cross-document link. Ultimately, the ODDraft::GetLink method returns an ODLink object to the destination part. The source part, whether in the same draft or in a different draft, is asked to create an ODLink object via the ODPart::CreateLink function. The part may refuse this request in which case the link cannot be created; normally the source part would refuse only in the event of an error. If the source part has not already created a link to the content described by the link specification, the source part calls its draft's CreateLinkSource method to create an ODLinkSource and ODLink object pair. The draft object associated with the source part is responsible for the ephemeral and persistent storage of both link objects. The source part keeps a reference to the ODLinkSource object, and returns a reference to the ODLink object. Source parts reference only ODLinkSource objects, and destination parts reference only ODLink objects. These reference restrictions are important in assuring the proper behavior when linked content is copied or moved. If the source part is in a different draft, the source part returns the ODLink object to the Link Manager. The source draft Link Manager creates a platform-dependent cross-document link, and returns the identity of the link to the destination draft Link Manager. The destination draft Link Manager calls the destination draft's CreateLinkSource method to create an ODLinkSource and ODLink object pair in the destination draft, and returns the ODLink object to the destination draft's GetLink method. The destination draft returns the ODLink object to the destination part. If the destination part wishes to be notified of changes to the link's content, it registers itself with the link object by calling ODLink::RegisterDependent. The link object will immediately call ODPart::LinkUpdated to force the part to read the link data. The part will call ODLink::GetContentStorageUnit to access the data. Whenever the source part wishes to inform the destination part of a change to a link's contents, it updates the storage unit associated with the link object and calls ODLink::ContentChanged. The link will call ODPart::LinkUpdated for all its dependent parts. Each dependent part will read the new data from the link's storage unit. A destination part's registration with a link is not permanent. Each time a part containing a link destination is initialized, it should re-register with the link object. A destination part may explicitly unregister itself with a link by calling ODLink::UnregisterDependent. This should be performed when the user breaks the link at the destination, for example, or if the linked content is deleted. A part writes content to and reads content from a link in exactly the same manner it uses to write and read the clipboard, except that a part should not write a link specification to the link. Invariants Maintained by Class The link always owns a valid storage unit. æKY ODLinkSource::ODLinkSource LinkSource::ODLinkSource LinkSource->ODLinkSource æT Class Method æD ODLinkSource(); æC Protection Public. Should only be called by ODDraft. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Initializes the ODLink object. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions The object is initialized to a known state. æKY ODLinkSource::~ODLinkSource LinkSource::~ODLinkSource LinkSource->~ODLinkSource æT Class Method æD ~ODLinkSource(); æC Protection Public. Should only be called by ODDraft. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Destroys the ODLink object. Inputs None Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODLinkSource::Clear LinkSource::Clear LinkSource->Clear æT Class Method æD void Clear( ODUpdateID id, ODLinkKey key); æC Protection Public. Parts call to prepare a link for rewriting its content. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Prepares a link for updating its content by removing the kODPropContents property. To notify destinations of the change, the ContentUpdated() method of this object must be called before calling Unlock(). The same update ID should be specified in both calls. The key parameter must be obtained by acquiring the lock via the Lock method of this object. The update identification argument should be the id causing this link to update, or, if the caller originated the update, obtained by calling the ODSession::UniqueUpdateID method. The Clear method may also be used in special circumstances to replace promised data when a new destination is created to an existing source. In this case, the caller must specify the existing update id as the parameter, and after writing promises in the contents property, unlock this object without calling ContentUpdated. Existing destinations will not be notified. Inputs id The update identification associated with the new empty content, or, to replace missing promised values, the existing update id. key A valid key returned by Lock(). Outputs None. Exceptions Signalled kODErrInvalidLinkKey The key argument is not valid. kODErrUnknownUpdateID The constant kODUnknownUpdate was supplied as the id argument. Pre conditions None. Post conditions The next call to GetContentStorageUnit returns a storage unit with no properties. æKY ODLinkSource::CloneTo LinkSource::CloneTo LinkSource->CloneTo æT Class Method æD ODStorageUnit* CloneTo( ODDraftKey draftKey, ODDraft* destDraft, ODStorageUnit* newSourcePartSU); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Clone this object into the destination draft. If 'newSourcePartSU' is non-nil, it must reference a storage unit in the destination draft; the source part property of the cloned object is set to reference this su. Inputs draftKey ODDraftKey identifying the Clone transaction. destDraft The draft to clone this object into. newSourcePartSU A storage unit pointer to a part in 'destDraft', or kODNULL . Outputs <return> The storage unit containing the persistent representation of this object in the destination draft. Exceptions Signalled kODErrCloneNotStarted A Clone was started unsuccessfully. kODErrInvalidDraftKey Invalid Clone. Pre conditions None. Post conditions None. æKY ODLinkSource::ContentUpdated LinkSource::ContentUpdated LinkSource->ContentUpdated æT Class Method æD void ContentUpdated( ODUpdateID id, ODLinkKey key); æC Protection Public. Called by parts after modifying the link's content. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Called by the source part after modifying the link's content to associate an update identification with the content. This method must be called before unlocking the link. All registered destinations are notified of the updated link contents when the link is unlocked. The source part should call the ODSession::UniqueUpdateID method to get a new update identification, unless the update resulted from an updated destination link. In that case, the source part should pass on the update ID associated with the destination link. Inputs id The update identification associated with the new content. key A valid key returned by Lock(). Outputs None. Exceptions Signalled kODErrInvalidLinkKey The key argument is not valid. kODErrUnknownUpdateID The constant kODUnknownUpdate was supplied as the id argument. Pre conditions ContentChanged should be called before Unlock to notify destinations of the update. Post conditions None. æKY ODLinkSource::Externalize LinkSource::Externalize LinkSource->Externalize æT Class Method æD void Externalize(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Externalizes persistent data Inputs None. Outputs None. Exceptions Signalled <Storage exceptions> Storage exceptions may be signalled. Pre conditions None. Post conditions The link's persistent storage unit is consistent with the link. æKY ODLinkSource::GetContentStorageUnit LinkSource::GetContentStorageUnit LinkSource->GetContentStorageUnit æT Class Method æD ODStorageUnit* GetContentStorageUnit( ODLinkKey key); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns a reference to the ODStorageUnit containing the content of the link. Inputs key A valid key returned by Lock(). Outputs <result> A reference to the content storage unit. Exceptions Signalled kODErrInvalidLinkKey The key argument is not valid. Pre conditions The key argument is a valid key returned by Lock(). Post conditions The returned storage unit is guaranteed to be valid until the key is relinquished by Unlock(). æKY ODLinkSource::GetLink LinkSource::GetLink LinkSource->GetLink æT Class Method æD ODLink* GetLink(); æC Protection Public. For use by drafts only. Parts should not call. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Return the link object associated with this link source. Drafts call this method to obtain a result to return from its GetLink method. Inputs None. Outputs <return> The ODLink object associated with this object. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODLinkSource::GetUpdateID LinkSource::GetUpdateID LinkSource->GetUpdateID æT Class Method æD ODUpdateID GetUpdateID(); æC Protection Public. Can be used by the Part maintaining this link source to determine if the link source should be updated. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns the current update identification of the link content. The returned value should be tested for equality only, as there is no implicit ordering of update ids. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODLinkSource::InitLinkSource LinkSource::InitLinkSource LinkSource->InitLinkSource æT Class Method æD void InitLinkSource( ODStorageUnit* storageUnit, ODPart* sourcePart); æC Protection Private. Only called by ODDraft; parts must not call. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Initializes a new link source object. Must be followed by a call to this object's SetLink method after the associated link object has been initialized. Inputs storageUnit The persistent storage unit for the link. sourcePart The part containing the source of the link, or kODNULL if the source is in another document. Outputs None. Exceptions Signalled kODErrOutOfMemory Out of memory. Pre conditions None. Post conditions The link object is partially initialized. æKY ODLinkSource::InitLinkSourceFromStorage LinkSource::InitLinkSourceFromStorage LinkSource->InitLinkSourceFromStorage æT Class Method æD void InitLinkSourceFromStorage( ODStorageUnit* storageUnit); æC Protection Public. Only called by ODDraft; parts must not call. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Internalizes the object from its persistent storage unit. Inputs storageUnit The persistent storage unit for the link object. Outputs None. Exceptions Signalled <Storage exceptions> Exceptions may be raised reading persistent properties. kODLinkBroken The associated link object could not be found. Pre conditions None. Post conditions The link source object is initialized. æKY ODLinkSource::IsAutoUpdate LinkSource::IsAutoUpdate LinkSource->IsAutoUpdate æT Class Method æD ODBoolean IsAutoUpdate(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns kODTrue if updates are automatically exported to other documents when the link's draft is saved. This setting defaults to kODTrue. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODLinkSource::Lock LinkSource::Lock LinkSource->Lock æT Class Method æD ODBoolean Lock( ODULong wait, ODLinkKey* key); æC Protection Public. Parts must call this method to aquire a key required by other methods. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Gain exclusive access to the content storage unit of the link. The value kODTrue is returned if the lock is granted; the key argument is set to a valid link key. Inputs wait The interval to wait for access to be granted. A value of zero means no wait, a value of ULONG_MAX means an indefinite wait. Other values are platform-dependent. Outputs <result> kODTrue if access is granted and kODFalse if denied. key If the result is kODTrue, a valid key value required by routines that access or modify the link's content. If the result is kODFalse, key is an undefined invalid key. Exceptions Signalled None. Pre conditions None. Post conditions If kODTrue is returned, the returned key provides exclusive access to the link's content. æKY ODLinkSource::Purge LinkSource::Purge LinkSource->Purge æT Class Method æD ODSize Purge( ODSize size); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Attempts to free any storage it can. Returns amount it was able to free. Inputs size Amount of memory requested Outputs Return value Amount of memory that was freed Exceptions Signalled None. Pre conditions None. Post conditions Some memory may be freed for use. æKY ODLinkSource::ReadLinkEdition LinkSource::ReadLinkEdition LinkSource->ReadLinkEdition æT Class Method æD void ReadLinkEdition( ODLinkKey key); æC Protection Public. Macintosh specific. Should only be called by the ODLinkManager object. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Link should update itself by reading its edition file. Inputs key A valid key returned by Lock(). Outputs None. Exceptions Signalled kODErrInvalidLinkKey Pre conditions None. Post conditions None. æKY ODLinkSource::ReleaseAll LinkSource::ReleaseAll LinkSource->ReleaseAll æT Class Method æD void ReleaseAll(); æC Protection Public. Should only be called by ODDraft objects. Parts do not call. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Used by the Draft to get the link to release all references to persistent obects. After calling this method, the effect of calling other methods is undefined. The link source object should be immediately deleted. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions The link source object has been initialized. Post conditions The link source object holds no references to other persistent objects. æKY ODLinkSource::SetAutoUpdate LinkSource::SetAutoUpdate LinkSource->SetAutoUpdate æT Class Method æD void SetAutoUpdate( ODBoolean automatic); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation If automatic is kODTrue, export updates to other documents when the link's draft is saved. If automatic is kODFalse, updates are exported when the ContentChanged method is called. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODLinkSource::SetLink LinkSource::SetLink LinkSource->SetLink æT Class Method æD void InitLinkSource( ODLink* link); æC Protection Public. Only called by ODDraft; parts must not call. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Completes initialization of this object. Should be called after the argument link object's InitLink method has been called. Inputs link The associated link object. Outputs None. Exceptions Signalled None. Pre conditions This object's InitLinkSource method has been called. Post conditions This object is fully initialized. æKY ODLinkSource::SetSourcePart LinkSource::SetSourcePart LinkSource->SetSourcePart æT Class Method æD void SetSourcePart( ODStorageUnit* sourcePartSU); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Change the part containing the source content of this link to the argument storage unit reference. This method is typically called on a cloned ODLinkSource object during data interchange operations involving linked content. Inputs sourcePartSU The storage unit for the new source part. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions The reference count of the previous source part storage unit is decremented. The reference count of the argument storage unit is incremented. æKY ODLinkSource::ShowLinkSourceInfo LinkSource::ShowLinkSourceInfo LinkSource->ShowLinkSourceInfo æT Class Method æD ODBoolean ShowLinkSourceInfo( ODFacet* facet, ODUpdateID change, ODBoolean changesAllowed, ODLinkInfoResult* infoResult); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Display the link dialog showing the information on a source link. If the return value of this function is kODFalse, that means the user has cancelled out of the dialog and no further action needs to be taken. Otherwise, the caller should examine infoResult and procced accordingly. Inputs change The update ID of the source content. facet facet over which the dialog should be displayed. changesAllowed If kODTrue, allow the user to change settings in the dialog, otherwise, the dialog is view only. Outputs <return> Boolean showing whether the user hits the OK buttom. infoResult a structure containing the result of the source link dialog. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODLinkSource::ShowSourceContent LinkSource::ShowSourceContent LinkSource->ShowSourceContent æT Class Method æD void ShowSourceContent(); æC Protection Public. Called by ODLink and ODLinkManager only. Parts should not call. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Causes the source part of the link to become active, makes the source content visible, and displays the link border. Throws an exception if the source part of the link cannot be located, or if the link has been broken at the source. Inputs None. Outputs None. Exceptions Signalled kODErrLinkBroken Cannot locate the source of the link. Pre conditions None. Post conditions None. æKY ODLinkSource::Unlock LinkSource::Unlock LinkSource->Unlock æT Class Method æD void Unlock( ODLinkKey key); æC Protection Public. Parts must call this method when done accessing or modifying the content of a link. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Relinquish a key returned by Lock(). Exclusive access to the link's content by this thread is relinquished if this thread did not already have exclusive access when the key was granted. Inputs key A valid key returned by Lock(). Outputs None. Exceptions Signalled kODErrInvalidLinkKey The key argument is not valid. Pre conditions The key argument is a valid key returned by Lock(). Post conditions The key is no longer valid. Exclusive access to the link's content is relinquished. æKY ODLinkSource::UseLinkEdition LinkSource::UseLinkEdition LinkSource->UseLinkEdition æT Class Method æD void UseLinkEdition( EditionContainerSpec editionContainer, ODFileSpec* documentSpec, ODULong sectionID, ODLinkKey key); æC Protection Public. Macintosh specific. Should only be called by the ODLinkManager object. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Subscribe to the argument edition container using the unique section ID. Inputs editionContainer Specifies the edition file to use as the source of the link. documentSpec The file containing this object's draft. sectionID The section identification to use for this link. key A valid key returned by Lock(). Outputs <result> An alias to the edition file. Exceptions Signalled kODErrInvalidLinkKey Pre conditions The link object's fLinkSource field is kODNULL. Post conditions The link object gets its content from a source part in another document via the specified edition file. æKY ODLinkSource::fAutoExport LinkSource::fAutoExport æT Class Field æD ODBoolean æC Persistent form OpenDoc:Property:AutoExport kODPropAutoExport kODTrue if link should be automatically exported when the draft is saved. æKY ODLinkSource::fChangeID LinkSource::fChangeID æT Class Field æD ODChangeID æC Persistent form OpenDoc:Property:ChangeID kODPropChangeID The change identification of the link's current content. æKY ODLinkSource::fContentSU LinkSource::fContentSU æT Class Field æD ODStorageUnit* æC Persistent form OpenDoc:Property:LinkContentSU kODPropLinkContentSU A reference to the storage unit containing the content of the link. æKY ODLinkSource::fLink LinkSource::fLink æT Class Field æD ODLink* æC Persistent form OpenDoc:Property:Link kODPropLink A reference to the companion ODLink object. æKY ODLinkSource::fSection LinkSource::fSection æT Class Field æD SectionHandle æC Persistent form OpenDoc:Property:LinkSection kODPropLinkSection When representing a link originating in another document, the section record associated with the link content. æKY ODLinkSource::fSourcePart LinkSource::fSourcePart æT Class Field æD ODPart* æC Persistent form OpenDoc:Property:SourcePart kODPropSourcePart A reference to the part containing the source of the link. æKY ODLinkSourceIteratorHelp ODLinkSourceIterator LinkSourceIterator æKL ODLinkSourceIterator::First ODLinkSourceIterator::InitLinkSourceIterator ODLinkSourceIterator::IsNotComplete ODLinkSourceIterator::Next æC Basic Class Documentation ODLinkSourceIterator is an iterator for the class ODLink. ODLinkSourceIterator is an abstract class with derived from ODObject. Container suites are responsible for subclassing ODLinkSourceIterator to provide the appropriate behavior. The factory method for ODLinkSourceIterator is ODDraft::CreateLinkSourceIterator. This class is not available to parts, but can be used by container applications. Theory of Operation This class is used to iterate over the link objects in a draft. Iteration is forward only, and links are returned in no particular order. After getting the iterator from ODDraft::CreateLinkSourceIterator(), First() should be used to access the first link in the iteration; thereafter, Next() can be called repeatedly to access the remaining links. First() and Next() will return kODNULL when all links have been returned. First() cannot be used to restart the iteration. Invariants Maintained by Class æKY ODLinkSourceIterator::First LinkSourceIterator::First LinkSourceIterator->First æT Class Method æD ODLinkSource First(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns an ODLinkSource object in the draft. The refcount of the object is not incremented. After creating an iterator using ODDraft::CreateLinkSourceIterator, call this method once, then call Next repeatedly to iterate through all link source objects in the draft. Inputs None. Outputs <return> An ODLinkSource object in the draft. If no link sources exist in the draft, kODNULL is returned, although the client should test for completion by calling IsNotComplete. Exceptions Signalled None. Pre conditions The iterator was created by ODDraft::CreateLinkSourceIterator. Post conditions A link source object is returned, or kODNULL if none exist in the draft. æKY ODLinkSourceIterator::InitLinkSourceIterator LinkSourceIterator::InitLinkSourceIterator LinkSourceIterator->InitLinkSourceIterator æT Class Method æD void InitLinkSourceIterator(); æC Protection Private. For use by factory methods only. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Initializes the iterator. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions First() may be called. æKY ODLinkSourceIterator::IsNotComplete LinkSourceIterator::IsNotComplete LinkSourceIterator->IsNotComplete æT Class Method æD ODBoolean IsNotComplete(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Test if iteration is complete. Inputs None. Outputs <return> Returns kODTrue if the last call to First or Next returned a valid ODLinkSource object, and kODFalse otherwise. Exceptions Signalled None. Pre conditions The list has been created and First() has been called to start the iteration. Post conditions None. æKY ODLinkSourceIterator::Next LinkSourceIterator::Next LinkSourceIterator->Next æT Class Method æD ODLinkSource Next(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns another link source object in the draft. Next can be called repeatedly to iterate through the remaining link source objects in the draft. IsNotComplete returns kODFalse if the preceeding call to Next did not return a link source object. Inputs None. Outputs <return> An ODLink object from the draft. If the iteration is complete kODNULL is returned, although the client should test for completion by calling IsNotComplete. Exceptions Signalled None. Pre conditions First has been called return a link source object in the draft. Post conditions None. æKY ODLinkSpecHelp ODLinkSpec LinkSpec æKL ODLinkSpec::ODLinkSpec ODLinkSpec::~ODLinkSpec ODLinkSpec::GetPart ODLinkSpec::GetPartData ODLinkSpec::GetProcessID ODLinkSpec::GetProcessLaunchDate ODLinkSpec::InitLinkSpec ODLinkSpec::ReadFromAppleEvent ODLinkSpec::ReadLinkSpec ODLinkSpec::WriteLinkSpec ODLinkSpec::WriteToAppleEvent ODLinkSpec::fPart ODLinkSpec::fPartData ODLinkSpec::fProcessID æC Basic Class Documentation This class represents potential links to part content. This class is not to be subclassed by the developer. For further information on the implementation of OpenDoc links, part developers are referred to the documentation for the ODLink and ODLinkSource classes. Specific methods of class ODPart and ODFrame are also relevant to a complete understanding of linking. Developers implementing a document shell and platform implementors are also referred to the documentation on the ODLinkManager. Theory of Operation A link specification represents a potential link to part content. When source part data is being copied or dragged, the source part should write out a link specification along with the content that it writes. This will be a signal that a link can be made to the source part. By implication, the value types available in the content define the value types available through the link. A recieving part creates a persistent link by calling the GetLink method of its ODDraft object, passing in the link specification. If the source part is in the same document, the draft calls the source part's CreateLink method, passing back the private data supplied by the source part when the link specification was created. If the source part is in another document, the draft object forwards the link specification to the link manager, which creates a cross-document link. An ODLinkSpec is a non-persistent object that contains methods for writing itself to and from a pre-focused storage unit as a value. A source part calls ODDraft::CreateLinkSpec() to originate the link specification. The source part supplies an untyped block of data to identify the content. While this data may be anything whatsoever, parts supporting the object model may find that an object specifier is a natural choice. The link specification can be turned into a storage unit value via the CopyToProperty method. By convention, the link specification is written to a kODPropLinkSpec property. The part receiving a link specification value creates a new ODLinkSpec object and calls its CopyFromProperty method to initialize it. If a link specification is written to the clipboard, and the content identified by the link specification is changed in a manner that doesn't affect the clipboard, the source part should remove the link specification from the clipboard. The source part can use clipboard change ids to determine that its content is still on the clipboard. A link spec value is meaningless after the document containing the part that created it is closed. Invariants Maintained by Class A link spec value identifies its source part across document boundaries. A link spec value identifies its source part until the document containing the source part is closed. æKY ODLinkSpec::ODLinkSpec LinkSpec::ODLinkSpec LinkSpec->ODLinkSpec æT Class Method æD ODLinkSpec(); æC Protection Public. Source parts should call ODDraft::CreateLinkSpec. The destination part calls this routine prior to reading a link specification value. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Creates an ODLinkSpec object. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions The object is initialized. æKY ODLinkSpec::~ODLinkSpec LinkSpec::~ODLinkSpec LinkSpec->~ODLinkSpec æT Class Method æD ~ODLinkSpec(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Destroys the ODLinkSpec object. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions This link specification object doesn't exist. æKY ODLinkSpec::GetPart LinkSpec::GetPart LinkSpec->GetPart æT Class Method æD ODPart* GetPart(); æC Protection Public. Should not be called by parts. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns stored part reference. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODLinkSpec::GetPartData LinkSpec::GetPartData LinkSpec->GetPartData æT Class Method æD ODByteArray GetPartData(); æC Protection Public. Should not be called by parts. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns a structure containing a copy of the part data. Inputs None. Outputs <return> An ODByteArray structure containing a copy of the part data. The client is responsible for disposing the pointer in the _buffer field of the structure. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODLinkSpec::GetProcessID LinkSpec::GetProcessID LinkSpec->GetProcessID æT Class Method æD ProcessSerialNumber GetProcessID(); æC Protection Public. Should not be called by parts. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns the process serial number of the originating part. Inputs None. Outputs <result> The process serial number of the process that originated this link specification. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODLinkSpec::GetProcessLaunchDate LinkSpec::GetProcessLaunchDate LinkSpec->GetProcessLaunchDate æT Class Method æD ODULong GetProcessLaunchDate(); æC Protection Public. Should not be called by parts. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns the launch date of the originating process. This value is used in the platform implementation to help ensure that the originating process is the correct one. Inputs None. Outputs <result> The launch date of the originating process. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODLinkSpec::InitLinkSpec LinkSpec::InitLinkSpec LinkSpec->InitLinkSpec æT Class Method æD void InitLinkSpec( ODPart* part, ODByteArray* partData); æC Protection Public. Should not be called by parts. Parts should call ODDraft:CreateLinkSpec(). Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Initializes this ODLinkSpec object with the supplied parameters. The caller is responsible for disposing of the partData argument. This routine may be called with nil arguments if ReadLinkSpec is called to initialize this object. Inputs part The part object creating this link spec, or nil if ReadLinkSpec will be called to set the source part. partData Arbitrary data for private use of the part in ODPart::CreateLink(). Nil may be passed if ReadLinkSpec will be called to set the source part data. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions This is an initialized ODLinkSpec object. æKY ODLinkSpec::ReadFromAppleEvent LinkSpec::ReadFromAppleEvent LinkSpec->ReadFromAppleEvent æT Class Method æD void ReadFromAppleEvent( AppleEvent* theAppleEvent); æC Protection Public. Should only be called by the Link Manager in creating a cross-document link. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Initialize this object from an Apple event. Inputs theAppleEvent An Apple event containing values for an ODLinkSpec object. Outputs None. Exceptions Signalled <platform errors> Host platform errors. Pre conditions The argument Apple event contains the values needed to initialize an ODLinkSpec object. Post conditions This is an initialized ODLinkSpec object. æKY ODLinkSpec::ReadLinkSpec LinkSpec::ReadLinkSpec LinkSpec->ReadLinkSpec æT Class Method æD void ReadLinkSpec( ODStorageUnit* su); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Initialize this link specification from a link spec value in the argument storage unit. The storage unit must be pre-focused to a property. Inputs su A storage unit that has been pre-focused to a property containing a link specification value. Outputs None. Exceptions Signalled kODErrNoLinkSpecValue Focused property does not contain a link specification value. kODErrCorruptLinkSpecValue Focused property contains an invalid link specification value. Pre conditions The argument storage unit is pre-focused to a property containing a link spec value. Post conditions This object is initialized to the link specification in the pre-focused storage unit. æKY ODLinkSpec::WriteLinkSpec LinkSpec::WriteLinkSpec LinkSpec->WriteLinkSpec æT Class Method æD void WriteLinkSpec( ODStorageUnit* su); æC Protection Public. Called by parts to put a link specification on the clipboard or drag-and-drop storage unit. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Write this object into a pre-focused storage unit. The argument storage unit must be pre-focused to a property. Inputs su A storage unit that has been pre-focused to a property to contain the link specification as a value. Outputs None. Exceptions Signalled None. Pre conditions The argument storage unit is focused to a property. Post conditions The argument storage unit contains a link specification value in its focused property. æKY ODLinkSpec::WriteToAppleEvent LinkSpec::WriteToAppleEvent LinkSpec->WriteToAppleEvent æT Class Method æD void WriteToAppleEvent( AppleEvent* theAppleEvent); æC Protection Public. Should only be called by the Link Manager in creating a cross-document link. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Write this object into an Apple event. Inputs theAppleEvent An Apple event record to contain the values in this object. Outputs None. Exceptions Signalled <platform errors> Host platform errors. Pre conditions None. Post conditions The argument Apple event contains the values in this object. æKY ODLinkSpec::fPart LinkSpec::fPart æT Class Field æD ODPart* æC æKY ODLinkSpec::fPartData LinkSpec::fPartData æT Class Field æD ODByteArray æC æKY ODLinkSpec::fProcessID LinkSpec::fProcessID æT Class Field æD ProcessSerialNumber æC æKY ODMenuBarHelp ODMenuBar MenuBar æKL ODMenuBar::ODMenuBar ODMenuBar::~ODMenuBar ODMenuBar::AddMenuBefore ODMenuBar::AddMenuLast ODMenuBar::AddSubMenu ODMenuBar::CheckCommand ODMenuBar::Copy ODMenuBar::DisableAll ODMenuBar::Display ODMenuBar::EnableAll ODMenuBar::EnableAndCheckCommand ODMenuBar::EnableCommand ODMenuBar::fSession ODMenuBar::fSystemMenus ODMenuBar::GetCommand ODMenuBar::GetItemString ODMenuBar::GetMenu ODMenuBar::GetMenuAndItem ODMenuBar::InitMenuBar ODMenuBar::IsCommandRegistered ODMenuBar::IsCommandSynthetic ODMenuBar::IsValid ODMenuBar::Purge ODMenuBar::RegisterCommand ODMenuBar::Release ODMenuBar::RemoveMenu ODMenuBar::SetItemString ODMenuBar::UnregisterAll ODMenuBar::UnregisterCommand æC Basic Class Documentation ODMenuBar represents a composite menu bar, made up of menus from the shell and the active part. ODMenuBar is a subclass of ODRefCntObject. ODMenuBar is implemented by platform vendors , and is platform-specific. ODMenuBar participates in the UI Events and Part Activation protocols. Theory of Operation Partly to facilitate interoperability with OLE 2.0., interactions with the menu bar are encapsulated in the ODMenuBar class. The document shell creates a menu bar, adds menus to it, and makes it the base menu bar by calling ODWindowState::SetBaseMenuBar(). Part Editors obtain a copy of the base menu bar by calling ODWindowState::CopyBaseMenuBar(). They then add menus to this copy, and call its Display() method to make it the current menu bar. Command Numbers and Menu Events: Unlike MS Windows, the Macintosh Menu Manager identifies a chosen menu item using the menu ID and item number, rather than allowing the programmer to associate a unique position-independent ID with a given menu item. The Macintosh implementation of OpenDoc allows the document shell application and part editors to register command IDs for menu items. A mouse down in the menu bar is turned into a menu event, with the message field containing the menu result, from which a part can obtain the command number. If no command is registered, a synthetic command is generated. If a command is not registered and not synthetic, a part should not be handling it. Invariants Maintained by Class æKY ODMenuBar::ODMenuBar MenuBar::ODMenuBar MenuBar->ODMenuBar æT Class Method æD ODMenuBar(); æC Protection Public. Part editors usually call ODWindowState::CopyBaseMenuBar() to create a menu bar. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Constructs the menu bar object. InitMenuBar must also be called. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions Instance is in a safe state æKY ODMenuBar::~ODMenuBar MenuBar::~ODMenuBar MenuBar->~ODMenuBar æT Class Method æD ~ODMacMenuBar(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Frees the memory allocated by this instance. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions The memory allocated by this instance is freed, and the instance is no longer usable. æKY ODMenuBar::AddMenuBefore MenuBar::AddMenuBefore MenuBar->AddMenuBefore æT Class Method æD void AddMenuBefore( ODMenuID menuID, ODPlatformMenu menu, ODPart* part, ODMenuID beforeID); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Inserts a menu before the menu with the specified ID. Inputs menuID The ID of the new menu menu The platform-specific menu structure part The part whichi owns the menu, or kODNULL if it is a shell menu. beforeID The ID of the menu before which to insert the new one. Outputs None. Exceptions Signalled kODErrOutOfMemory Out of memory Pre conditions A valid initialized instance. Post conditions The collection of menus contains the specified menu. æKY ODMenuBar::AddMenuLast MenuBar::AddMenuLast MenuBar->AddMenuLast æT Class Method æD void AddMenuLast( ODMenuID menuID, ODPlatformMenu menu, ODPart* part); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Appends a menu to the end of the menu bar. Inputs menuID The ID of the new menu menu The platform-specific menu structure part The part which owns the menu, or kODNULL if it is a shell menu. Outputs None. Exceptions Signalled kODErrOutOfMemory Out of memory Pre conditions A valid initialized instance. Post conditions The collection of menus contains the specified menu. æKY ODMenuBar::AddSubMenu MenuBar::AddSubMenu MenuBar->AddSubMenu æT Class Method æD void AddSubMenu( ODMenuID menuID, ODPlatformMenu menu, ODPart* part); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Adds a submenu to the menu list (required on Macintosh) Inputs menuID The ID of the new menu menu The platform-specific menu structure part The part whichi owns the menu, or kODNULL if it is a shell menu. Outputs None. Exceptions Signalled kODErrOutOfMemory Out of memory Pre conditions A valid initialized instance. Post conditions The collection of menus contains the specified sub menu. æKY ODMenuBar::CheckCommand MenuBar::CheckCommand MenuBar->CheckCommand æT Class Method æD void CheckCommand( ODCommandID cmdNumber, ODBoolean check); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Places a check mark on the menu item, or unchecks it. Inputs cmdNumber The command number of the menu item to check check Whether or not to check the item Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODMenuBar::Copy MenuBar::Copy MenuBar->Copy æT Class Method æD ODMenuBar* Copy(); æC Protection Public. Call by WindowState::CopyBaseMenuBar. Parts don't typically call this method. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Clones this object, including its command table. Inputs None. Outputs <return> A copy of this menu bar Exceptions Signalled None. Pre conditions A valid initialized menu bar. Post conditions No effect on this instance. æKY ODMenuBar::DisableAll MenuBar::DisableAll MenuBar->DisableAll æT Class Method æD void DisableAll(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Disables all menus in the menu bar, except for system menus (Apple, Help, Process) Inputs None. Outputs None. Exceptions Signalled None. Pre conditions An initialized menu bar Post conditions All menus besides system menus are enabled. æKY ODMenuBar::Display MenuBar::Display MenuBar->Display æT Class Method æD void Display(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Installs this menu bar as the current menu bar. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions The current menu bar contains the menus in this instance. æKY ODMenuBar::EnableAll MenuBar::EnableAll MenuBar->EnableAll æT Class Method æD void EnableAll(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Enables all menus in the menu bar, except for system menus (Apple, Help, Process) Inputs None. Outputs None. Exceptions Signalled None. Pre conditions An initialized menu bar Post conditions All menus besides system menus are enabled. æKY ODMenuBar::EnableAndCheckCommand MenuBar::EnableAndCheckCommand MenuBar->EnableAndCheckCommand æT Class Method æD void EnableAndCheckCommand( ODCommandID cmdNumber, ODBoolean enable, ODBoolean check) ; æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Enables/disables and/or checks/unchecks the specified menu item Inputs cmdNumber The item to enable/check enable kODTrue to enable, kODFalse to disable. check kODTrue to check, kODFalse to uncheck. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODMenuBar::EnableCommand MenuBar::EnableCommand MenuBar->EnableCommand æT Class Method æD void EnableCommand( ODCommandID cmdNumber, ODBoolean enable); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Enables/disables the specified menu item. Inputs cmdNumber The menu item to enable/disable enable kODTrue to enable, kODFalse to disable Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODMenuBar::fSession MenuBar::fSession MenuBar->fSession æT Class Method æD æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation None. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODMenuBar::fSystemMenus MenuBar::fSystemMenus MenuBar->fSystemMenus æT Class Method æD æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation None. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODMenuBar::GetCommand MenuBar::GetCommand MenuBar->GetCommand æT Class Method æD ODCommandID GetCommand( ODMenuID menu, ODMenuItemID menuItem); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the command ID registered for the specified menu and menu item. Inputs menu The menu ID. menuItem The menu item. Outputs <return> A command number, or kODNoCommand Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions No effect on this instance. æKY ODMenuBar::GetItemString MenuBar::GetItemString MenuBar->GetItemString æT Class Method æD void GetItemString( ODCommandID cmdNumber, Str255Param itemString); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the text of the specified menu item. Inputs cmdNumber The item whose text you wish to obtain. Outputs itemString Returns the requested text Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODMenuBar::GetMenu MenuBar::GetMenu MenuBar->GetMenu æT Class Method æD ODPlatformMenu GetMenu( ODMenuID menu); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the platform-specific menu structure (menu handle on Macintosh) for the specified menu ID. Inputs menu The ID of the desired menu. Outputs <return> The menu handle Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODMenuBar::GetMenuAndItem MenuBar::GetMenuAndItem MenuBar->GetMenuAndItem æT Class Method æD void GetMenuAndItem( ODCommandID command, ODMenuID& menu, ODMenuItemID& menuItem); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Given a command ID, returns the menu and item for that command, registered or synthetic. Inputs command The command to "decompose" Outputs menu The associated menu menuItem The associated menu item Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions No effect on this instance. æKY ODMenuBar::InitMenuBar MenuBar::InitMenuBar MenuBar->InitMenuBar æT Class Method æD InitMenuBar( ODSession* session, ODPlatformMenuBar menuBar); æC Protection Public. Part editors usually call ODWindowState::CopyBaseMenuBar() Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Initializes the menu bar object. Must be called immediately after new(). Inputs session The OpenDoc session object. menuBar The shared systen-wide menu bar handle Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODMenuBar::IsCommandRegistered MenuBar::IsCommandRegistered MenuBar->IsCommandRegistered æT Class Method æD ODBoolean IsCommandRegistered( ODCommandID command); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns kODTrue of the specified command ID is registered in this menu bar. Inputs command The command ID to check Outputs <return> kODTrue, if the command is registered, otherwise kODFalse Exceptions Signalled None. Pre conditions A valid initialized instance Post conditions No effect on this instance. æKY ODMenuBar::IsCommandSynthetic MenuBar::IsCommandSynthetic MenuBar->IsCommandSynthetic æT Class Method æD ODBoolean IsCommandSynthetic( ODCommandID command); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns kODTrue if the specified command ID is synthetic, i.e. one manufactured from the menu and item IDs. Inputs command The command ID to check Outputs <result> kODTrue, if the command is synthetic. Exceptions Signalled None. Pre conditions A valid initialized instance Post conditions No effect on this instance. æKY ODMenuBar::IsValid MenuBar::IsValid MenuBar->IsValid æT Class Method æD ODBoolean IsValid(); æC Protection Public. Must be called by parts. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns kODTrue if the base menu bar has changed since this one was copied from the base menu bar. Parts shoould check this before displaying the menu bar, and recopy if necessary. Inputs None. Outputs <return> kODTrue, if the base menu bar has changed Exceptions Signalled None. Pre conditions A valid initialized menu bar instance Post conditions Result contains true if the base menu bar has changed since this one æKY ODMenuBar::Purge MenuBar::Purge MenuBar->Purge æT Class Method æD ODSize Purge( ODSize size); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Tries to free up some memory Inputs size The amount of memory requested Outputs <return> The amount of memory freed. Exceptions Signalled None. Pre conditions Constructed and initialized object. Post conditions Some internal structures which are readily rebuilt may have been freed. æKY ODMenuBar::RegisterCommand MenuBar::RegisterCommand MenuBar->RegisterCommand æT Class Method æD void RegisterCommand( ODCommandID command, ODMenuID menu, ODMenuItemID menuItem); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Associates a Command ID with a specifed menu and menu item. Inputs command A 32-bit command number menu A menu ID menuItem A menu item number Outputs None. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions The command/(menu,item) association is added to a table. æKY ODMenuBar::Release MenuBar::Release MenuBar->Release æT Class Method æD void Release(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Overridden to delete this object if the reference count has gone to zero. Inputs None Outputs None Exceptions Signalled None. Pre conditions ??? Post conditions ??? æKY ODMenuBar::RemoveMenu MenuBar::RemoveMenu MenuBar->RemoveMenu æT Class Method æD void RemoveMenu( ODMenuID menu); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Removes the menu with the specified ID. The diplayed menu bar is not affected. Inputs menu The id of the menu to remove Outputs None. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions The menu is no longer in this menu bar. The diplayed menu bar is not affected. æKY ODMenuBar::SetItemString MenuBar::SetItemString MenuBar->SetItemString æT Class Method æD void SetItemString( ODCommandID cmdNumber, ConstStr255Param itemString); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Sets the text of the specified menu item. Inputs cmdNumber The menu item to change itemString The desired text for the specified menu item Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODMenuBar::UnregisterAll MenuBar::UnregisterAll MenuBar->UnregisterAll æT Class Method æD void UnregisterAll(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Unregisters all command numbers in this menu bar. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions A valid initialized instance Post conditions No Command IDs are registered in this menu bar. æKY ODMenuBar::UnregisterCommand MenuBar::UnregisterCommand MenuBar->UnregisterCommand æT Class Method æD void UnregisterCommand( ODCommandID command); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Remove the association between the specified command ID and its menu and item. Inputs command A command ID Outputs None. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions The association is removed. æKY ODMessageInterfaceHelp ODMessageInterface MessageInterface æKL ODMessageInterface::ODMessageInterface ODMessageInterface::~ODMessageInterface ODMessageInterface::CreateEvent ODMessageInterface::CreatePartAddrDesc ODMessageInterface::CreatePartObjSpec ODMessageInterface::InitMessageInterface ODMessageInterface::ProcessSemanticEvent ODMessageInterface::Purge ODMessageInterface::Send ODMessageInterface::fTransactionTable æC Basic Class Documentation This class encapsulates AppleEvent message sending functionality. It works in concert with the ODSemanticInterface class. The ODSession object allows access to an instance of this object for any clients who wish to use it. The platform vendor will implement. ODMessageInterface is a subclass of ODObject. A minimum of documentation is given for functions that have counterparts in the AppleEvent Manager. Only differences are pointed out. The OSErr return value normally returned by these functions will instead be signalled via an exception should it not be equal to noErr. Only exceptions that are different from, or exceptions that occur in addition to the normal AppleEvent exceptions, are documented. Theory of Operation The functions of this class are direct counterparts to the associated AppleEvent functions. AppleEvents will be used to implement the member functions of this class. An extra parameter or type ODPart has been added to many of the functions. This is used to specify the context that should be used when performing the function. A special value of ODPart*, kODAppShell is used to denote the application shell "part". Invariants Maintained by Class None. æKY ODMessageInterface::ODMessageInterface MessageInterface::ODMessageInterface MessageInterface->ODMessageInterface æT Class Method æD ODMessageInterface(); æC Protection Private. Should only be called by ODSession Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Initialize the object. Inputs session The session that contains this MessageInterface object Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions Object is instantiated. æKY ODMessageInterface::~ODMessageInterface MessageInterface::~ODMessageInterface MessageInterface->~ODMessageInterface æT Class Method æD ODVMethod ~ODMessageInterface(); æC Protection Private. Should only be called by ODSession Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Destroy the object. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions Object is destroyed. æKY ODMessageInterface::CreateEvent MessageInterface::CreateEvent MessageInterface->CreateEvent æT Class Method æD virtual void CreateEvent( AEEventClass theAEEventClass, AEEventID theAEEventID, AEAddressDesc target, ODSLong transactionID, AppleEvent* result); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation See AppleEvent Manager documentation. The returnID parameter has been removed since OpenDoc will use this to track the origin of a Send. Inputs theAEEventClass <See AppleEvent Manager documentation> theAEEventID <See AppleEvent Manager documentation> target <See AppleEvent Manager documentation> transactionID <See AppleEvent Manager documentation> Outputs result Apple event created <return> The return id assigned to this event. Exceptions Signalled kODOutOfMemory Couldn't allocate memory for the event. others <See AppleEvent Manager documentation> Pre conditions None. Post conditions An event will be created. æKY ODMessageInterface::CreatePartAddrDesc MessageInterface::CreatePartAddrDesc MessageInterface->CreatePartAddrDesc æT Class Method æD ODVMethod void CreatePartAddrDesc( AEDesc* theAddressDesc, ODPart* thePart); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Create an address descriptor to be used when sending events to the part in question. Inputs thePart The ODPart* to be addressed. Outputs theAddressDesc The descriptor to be initialized. Exceptions Signalled kXODErrNotAValidPart ODPart* was not valid. Pre conditions None. Post conditions The address descriptor is initialized. æKY ODMessageInterface::CreatePartObjSpec MessageInterface::CreatePartObjSpec MessageInterface->CreatePartObjSpec æT Class Method æD ODVMethod void CreatePartObjSpec( AEDesc* theObjSpec, ODPart* thePart); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Creates an object specifier that can be used to refer to the part in question. Should not be stored persistently. Is only valid while the ODPart is instantiated. Inputs thePart The part for which an object specifier will be constructed. Outputs theObjSpec The object specifier to be initialized Exceptions Signalled kXODErrNotAValidPart ODPart* was not valid. Pre conditions None. Post conditions The object specifier is initialized æKY ODMessageInterface::InitMessageInterface MessageInterface::InitMessageInterface MessageInterface->InitMessageInterface æT Class Method æD void InitMessageInterface( ODSession* session); æC Protection Private. Should only be called by ODSession. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Initializes the object. Inputs session A reference to the ODSession object. Outputs None. Exceptions Signalled kODOutOfMemory Not enough memory for needed storage. Pre conditions None. Post conditions Reply handler, event handler and coercion handler installed. æKY ODMessageInterface::ProcessSemanticEvent MessageInterface::ProcessSemanticEvent MessageInterface->ProcessSemanticEvent æT Class Method æD virtual ODBoolean ProcessSemanticEvent( const ODEventData* theEvent); æC Protection Public. Probably only called from an ODDispatchModule. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation See AppleEvent Manager documentation. This function is similiar to AEProcessAppleEvent, but it may not call AEProcessAppleEvent at all. It is responsible to for dispatching a semantic event to the correct object and using the corrent ODSemanticInterface object owned by that object for further dispatching. The object will either be the application shell / document or a part. Inputs theEvent <See AppleEvent Manager documentation> Outputs <return> Whether the event was processed. Exceptions Signalled kODEResolveError Couldn't determine correct object to dispatch to. Pre conditions None. Post conditions Event will be dispatched. æKY ODMessageInterface::Purge MessageInterface::Purge MessageInterface->Purge æT Class Method æD ODSize Purge( ODSize howMuch); æC Protection Public. Override policy Derived class can override. Derived class must call base class behavior. Basic operation None. Inputs howMuch Amount of memory requested to be purged. Outputs <return> Amount of memory that was released. Exceptions Signalled None. Pre conditions None. Post conditions Memory may have been freed. æKY ODMessageInterface::Send MessageInterface::Send MessageInterface->Send æT Class Method æD virtual ODSShort Send( ODPart* thePart, AppleEvent* theAppleEvent, AppleEvent* reply, AESendMode sendMode, AESendPriority sendPriority, ODULong timeOutInTicks); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation See AppleEvent Manager documentation. The ODPart* parameter specifies the sender of the event. OpenDoc handles events and idle time, so these callbacks are unnecessary. Inputs thePart The sending ODPart or kODAppShell if the sender is the application shell / document. theAppleEvent <See AppleEvent Manager documentation> sendMode <See AppleEvent Manager documentation> sendPriority <See AppleEvent Manager documentation> timeOutInTicks <See AppleEvent Manager documentation> Outputs reply <See AppleEvent Manager documentation> Exceptions Signalled kODEInvalidPart Invalid part. kODEInvalidSemanticEvent Invalid AppleEvent (not created with ODMessageInterface::CreateEvent ). others <See AppleEvent Manager documentation> Pre conditions A valid AppleEvent created by ODMessageInterface::CreateEvent is required. Post conditions Event will be sent. æKY ODMessageInterface::fTransactionTable MessageInterface::fTransactionTable æT Class Field æD ODTransationTable* fTransactionTable; æC æKY ODNameResolverHelp ODNameResolver NameResolver æKL ODNameResolver::ODNameResolver ODNameResolver::~ODNameResolver ODNameResolver::CallObjectAccessor ODNameResolver::CreateSwapToken ODNameResolver::DisposeToken ODNameResolver::GetContextFromToken ODNameResolver::GetUserToken ODNameResolver::InitNameResolver ODNameResolver::IsODToken ODNameResolver::Purge ODNameResolver::Resolve æC Basic Class Documentation This class encapsulates structured name or object specifier resolution functionality. It works in concert with the ODSemanticInterface class. The ODSession object allows access to an instance of this object for any clients who wish to use it. The platform vendor will implement. ODNameResolver is a subclass of ODObject A minimum of documentation is given for functions that have counterparts in the AppleEvent Manager. Only differences are pointed out. The OSErr return value normally returned by these functions will instead be signalled via an exception should it not be equal to noErr. Only exceptions that are different from, or exceptions that occur in addition to the normal AppleEvent exceptions, are documented. Theory of Operation The functions of this class are direct counterparts to the associated AppleEvent object model functions. A new version of the OSL, one supports "contexts" will be used to implement the member functions of this class. Resolution of object specifiers will take into account ODParts working as pseudo-applications. This class provides private services tothe ODMessageInterface class for getting and setting the current context part. Invariants Maintained by Class None. æKY ODNameResolver::ODNameResolver NameResolver::ODNameResolver NameResolver->ODNameResolver æT Class Method æD ODNameResolver(); æC Protection Private. Only to be called by ODSession. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Constructs class. Inputs None Outputs None Exceptions Signalled None. Pre conditions None. Post conditions Object is created. æKY ODNameResolver::~ODNameResolver NameResolver::~ODNameResolver NameResolver->~ODNameResolver æT Class Method æD virtual ~ODNameResolver(); æC Protection Private. Only to be called by ODSession. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Destroys object. Inputs None Outputs None Exceptions Signalled None. Pre conditions None. Post conditions Object is destroyed. æKY ODNameResolver::CallObjectAccessor NameResolver::CallObjectAccessor NameResolver->CallObjectAccessor æT Class Method æD virtual void CallObjectAccessor( ODPart* part, DescType desiredClass, ODOSLToken* containerToken, DescType containerClass, DescType keyForm, AEDesc* keyData, ODOSLToken* token); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation See AppleEvent Manager documentation for AECallObjectAccessor. part is the part whose accessor is to be called. Inputs part The part containing desired object accessor. desiredClass The object class of the desired Apple event objects. containerToken The token that identifies the container for the desired objects. containerClass The object class of the container for the desired objects. keyForm The key form specified by the object specifier record for the object or objects to be located. keyData The key data specified by the object specifier record for the object or objects to be located. token The token returned by the object accessor call. Outputs None Exceptions Signalled See AppleEvent Mgr documentation. Pre conditions None. Post conditions Whatever side effects the invocation of the accessor produces. æKY ODNameResolver::CreateSwapToken NameResolver::CreateSwapToken NameResolver->CreateSwapToken æT Class Method æD ; æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Construct an AppleEvent token that encodes an ODFrame and an ODPart. Inputs frame The ODFrame represented by this token. May be kODNULL if the part has not display frames. part The part to which the frame belongs. Outputs token The token constructed. Exceptions Signalled kODErrOutOfMemory Out of Memory Pre conditions None. Post conditions A new token is constructed. æKY ODNameResolver::DisposeToken NameResolver::DisposeToken NameResolver->DisposeToken æT Class Method æD virtual void DisposeToken( ODOSLToken* theToken); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation See AppleEvent Object Model documentation. Inputs theToken The token to dispose. Outputs None. Exceptions Signalled kODErrInvalidPart Token does not contain a valid part description. Pre conditions None. Post conditions Token is destroyed. æKY ODNameResolver::GetContextFromToken NameResolver::GetContextFromToken NameResolver->GetContextFromToken æT Class Method æD æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Get the context in which this ODOSLToken was created. The part returned by this represents the part that knows how to interpret this token. frame represents the display frame of the part for which this token makes sense (for parts with multiple display frames) Inputs token The token of interest Outputs part the part corresponding to this token. frame the frame corresponding to this token. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODNameResolver::GetUserToken NameResolver::GetUserToken NameResolver->GetUserToken æT Class Method æD æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Get a reference to a ODDesc that can be used to store private data. Inputs token The OpenDoc token Outputs userToken A reference to an ODDesc that can be used to store private data. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODNameResolver::InitNameResolver NameResolver::InitNameResolver NameResolver->InitNameResolver æT Class Method æD void InitNameResolver( ODSession* session); æC Protection Private. Should only be called by ODSession. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Initializes the object. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions The object is initialized. æKY ODNameResolver::IsODToken NameResolver::IsODToken NameResolver->IsODToken æT Class Method æD æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Check to see whether an ODDesc is actually a token or not. If it is an OpenDoc token, the methods SetUserToken, GetUserToken and GetContextFromToken can be called with that ODDesc as the ODOSLToken parameter Inputs desc The ODDesc of interest Outputs <return> Whether or not the ODDesc is an ODOSLToken. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODNameResolver::Purge NameResolver::Purge NameResolver->Purge æT Class Method æD ODSize Purge( ODSize howMuch); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Free unused memory. Inputs howMuch The memory requested to be freed. Outputs Return The amount of memory that was freed. Exceptions Signalled None. Pre conditions None. Post conditions Some memory may have been freed. æKY ODNameResolver::Resolve NameResolver::Resolve NameResolver->Resolve æT Class Method æD virtual ODPart* Resolve( ODObjectSpec* theObject, ODOSLToken* token, ODPart* contextPart); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation See AppleEvent Object Model documentation for AEResolve. A new type, ODOSLToken is used for the token instead of an AEDesc. The fields of the struct are exactly the same however. The extra ODPart* parameter is used to describe the context of the resolution, i.e., the part who is making the call. Inputs theObject The object specifier to be resolved. contextPart The part from which the call is being made. Outputs token The final token produced by the resolution. Exceptions Signalled kODOutOfMemory Couldn't allocate needed internal structures. errAENoSuchObject Invalid ODPart* or part does not support the Semantic Interface extension. Others Parts and the OSL may generate exceptions. These exceptions may be returned by Resolve. Pre conditions None. Post conditions A new token will have been created for the object described in theObject. Many part-specific routines will be called back to. æKY ODNameSpaceHelp ODNameSpace NameSpace æKL ODNameSpace::ODNameSpace ODNameSpace::~ODNameSpace ODNameSpace::Exists ODNameSpace::GetName ODNameSpace::GetParent ODNameSpace::GetType ODNameSpace::InitNameSpace ODNameSpace::ReadFromFile ODNameSpace::ReadFromStorage ODNameSpace::SetType ODNameSpace::Unregister ODNameSpace::WriteToFile ODNameSpace::WriteToStorage æC Basic Class Documentation This class represents a name space. Objects of this class are created by member functions of the ODNameSpaceManager class. The platform vendor will implement. ODNameSpace is a subclass of ODObject. Theory of Operation This class allows registering ODPtrs with three different types of keys: ODISOStr, ODOSType and ODSLong. Values are hashed for quick lookup. Invariants Maintained by Class There is always a valid hash table instantiated to hold the key/value pairs. It may be empty. æKY ODNameSpace::ODNameSpace NameSpace::ODNameSpace NameSpace->ODNameSpace æT Class Method æD ODNameSpace(); æC Protection Private. Only called by ODNameSpaceManager::CreateNameSpace. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Initialize an ODNameSpace class Inputs None. Outputs None Exceptions Signalled None. Pre conditions None. Post conditions A new ODNameSpace class will be created. æKY ODNameSpace::~ODNameSpace NameSpace::~ODNameSpace NameSpace->~ODNameSpace æT Class Method æD virtual ~ODNameSpace(); æC Protection Private. Called only by ODNameSpaceManager::DeleteNameSpace. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Destroys the ODNameSpace object and any associated storage. Inputs None Outputs None Exceptions Signalled None. Pre conditions None. Post conditions Object all gone. æKY ODNameSpace::Exists NameSpace::Exists NameSpace->Exists æT Class Method æD virtual ODPtr Exists( ODISOStr key); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns boolean for the existance of the given key. Inputs key The key for the entry requested. Outputs Boolean True if key exists. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODNameSpace::GetName NameSpace::GetName NameSpace->GetName æT Class Method æD virtual ODISOStr GetName(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return the ISO string assigned to this object at initialization time. Inputs None Outputs Return name of this name space. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODNameSpace::GetParent NameSpace::GetParent NameSpace->GetParent æT Class Method æD ODNameSpace GetParent(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation None. Inputs None Outputs Return partent name space. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODNameSpace::GetType NameSpace::GetType NameSpace->GetType æT Class Method æD ODNSTypeSpec GetType(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation None. Inputs None Outputs Return type object name space or value name space. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODNameSpace::InitNameSpace NameSpace::InitNameSpace NameSpace->InitNameSpace æT Class Method æD void Initialize( ODNameSpaceManager* mgr, ODNameSpace* parent, ODULong numExpectedEntries, ODISOStr name, ODHeap heap); æC Protection Private. Should only be called by ODNameSpaceManager Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Initializes the object. Inputs mgr The NameSpaceManager object that this NameSpace belongs to. parent An ODNameSpace to search if a GetValue fails in this one. numExpectedEntries The number of expected entries. name the name to give this ODNameSpace. heap The memory heap that this object is to be allocated in. Outputs None. Exceptions Signalled kODErrOutOfMemory Out of memory. Pre conditions None. Post conditions The object will be initialized. æKY ODNameSpace::ReadFromFile NameSpace::ReadFromFile NameSpace->ReadFromFile æT Class Method æD void ReadFromFile( PlatformFile file); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Read the name space from the file into this ODNameSpace. Assumes that the data was written with WriteToFile. If the name of the name space doesn not match that that was stored in the stream, an exception will be thrown. It's assumed that the file's cursor has been placed at the beginning of the data stream. Inputs file The file from which to read the data. Outputs None. Exceptions Signalled kODErrInvalidName The stored name does not match that of the name space. Pre conditions Data must have been streamed with WriteToFile. Post conditions The name space will contain entries corresponding to the streamed data. æKY ODNameSpace::ReadFromStorage NameSpace::ReadFromStorage NameSpace->ReadFromStorage æT Class Method æD void ReadFromStorage( ODStorageUnitView* view); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Read the name space from storage into this ODNameSpace. Assumes that the data was written with WriteToStorage. If the name of the name space doesn not match that that was stored in the stream, an exception will be thrown. Inputs view The storage unit from which to read the data. Outputs None. Exceptions Signalled kODErrInvalidName The stored name does not match that of the name space. Pre conditions Data must have been streamed with WriteToStorage. Post conditions The name space will contain entries corresponding to the streamed data. æKY ODNameSpace::SetType NameSpace::SetType NameSpace->SetType æT Class Method æD void SetType( ODNSTypeSpec type); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation None. Inputs type Name space type. Outputs None Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODNameSpace::Unregister NameSpace::Unregister NameSpace->Unregister æT Class Method æD virtual void Unregister( ODISOStr key); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Removes the given entry from the ODNameSpace. Inputs key Key for the entry to be removed. Outputs None Exceptions Signalled None. Pre conditions The given entry must have been registered. No error is signalled, however, if the key does not already exist. Post conditions The given entry will be removed. æKY ODNameSpace::WriteToFile NameSpace::WriteToFile NameSpace->WriteToFile æT Class Method æD void WriteToFile( PlatformFile file); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Write the name space out as a stream to the file. This stream may be read back in by ReadFromFile. Inputs file The file to which to write the data. Outputs None. Exceptions Signalled misc File system errors and/or storage errors. Pre conditions None. Post conditions Data will be written out to the given file. æKY ODNameSpace::WriteToStorage NameSpace::WriteToStorage NameSpace->WriteToStorage æT Class Method æD void WriteToStorage( ODStorageUnitView* view); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Write the name space out as a stream to the storage unit view. This stream may be read back in by ReadFromStorage. Inputs view The storage unit to which to write the data. Outputs None. Exceptions Signalled misc File system errors and/or storage errors. Pre conditions None. Post conditions Data will be written out to storage. æKY ODNameSpaceManagerHelp ODNameSpaceManager NameSpaceManager æKL ODNameSpaceManager::ODNameSpaceManager ODNameSpaceManager::~ODNameSpaceManager ODNameSpaceManager::CreateNameSpace ODNameSpaceManager::DeleteNameSpace ODNameSpaceManager::HasNameSpace ODNameSpaceManager::InitNameSpaceManager ODNameSpaceManager::Purge ODNameSpaceManager::UpdatePreferences ODNameSpaceManager::fNameSpaceTable ODNameSpaceManager::fPreferences ODNameSpaceManager::fSession æC Basic Class Documentation This class represents a a bottleneck for the creation of ODNameSpaces to be used by the ODBinding object. It keeps track of ODNameSpaces created and destroyed so that they may later be found by name. Objects of this class are created by member functions of the ODSession class and by the ODMacSystemSession class. The platform vendor will implement. ODNameSpaceManager is a subclass of ODObject. Theory of Operation This class allows inheritance of ODNameSpaces so that a search can take place in more than one ODNameSpace. Invariants Maintained by Class A valid list of ODNameSpaces (possibly empty) exists. æKY ODNameSpaceManager::ODNameSpaceManager NameSpaceManager::ODNameSpaceManager NameSpaceManager->ODNameSpaceManager æT Class Method æD ODNameSpaceManager(); æC Protection Private. Only to be called by ODBaseSession::ODBaseSession(). Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Initializes private variables. Inputs None Outputs None Exceptions Signalled None Pre conditions None. Post conditions An ODNameSpaceManager object is created. æKY ODNameSpaceManager::~ODNameSpaceManager NameSpaceManager::~ODNameSpaceManager NameSpaceManager->~ODNameSpaceManager æT Class Method æD virtual ~ODNameSpaceManager(); æC Protection Private. Only to be called by the ODBaseSession class. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Destroys the ODNameSpaceManager object. Inputs None Outputs None Exceptions Signalled None. Pre conditions None. Post conditions Object destroyed. æKY ODNameSpaceManager::CreateNameSpace NameSpaceManager::CreateNameSpace NameSpaceManager->CreateNameSpace æT Class Method æD virtual ODNameSpace* CreateNameSpace( ODISOStr spaceName, ODNameSpace* inheritsFrom, ODULong numExpectedEntries, ODNSTypeSpce type); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Creates an ODNameSpace object with specified parameters. An exception is signalled if an ODNameSpace with the given name already exists. Inputs spaceName The name the caller wishes to give to this ODNameSpace inheritsFrom An ODNameSpace to search if a GetValue fails in this one. numExpectedEntries The number of expected entries to be made in this ODNameSpace. type either a value name space or an object name space. Outputs Return The name space created. Exceptions Signalled kODErrOutOfMemory Not enough memory kODErrKeyAlreadyExists An ODNameSpace with that name already exists. Pre conditions None. Post conditions A new ODNameSpace object is created and recorded in a list. æKY ODNameSpaceManager::DeleteNameSpace NameSpaceManager::DeleteNameSpace NameSpaceManager->DeleteNameSpace æT Class Method æD virtual void DeleteNameSpace( ODNameSpace* theNameSpace); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Delete specificied ODNameSpace object. Inputs theNameSpace The ODNameSpace to be destroyed Outputs None Exceptions Signalled None. Pre conditions None. Post conditions The specified ODNameSpace object will be destroyed. æKY ODNameSpaceManager::HasNameSpace NameSpaceManager::HasNameSpace NameSpaceManager->HasNameSpace æT Class Method æD virtual ODBoolean HasNameSpace( ODISOStr spaceName); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Finds out whether a given ODNameSpace exists. Inputs spaceName the name of the ODNameSpace to find. Outputs Return If true, the ODNameSpace exists. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODNameSpaceManager::InitNameSpaceManager NameSpaceManager::InitNameSpaceManager NameSpaceManager->InitNameSpaceManager æT Class Method æD void InitNameSpaceManager( ODBaseSession* session); æC Protection Private. Should only be called by ODBaseSession. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Initializes the ODNameSpaceManager object. Inputs session The session that the NameSpaceManger object belongs to. Outputs None Exceptions Signalled kODOutOfMemory Out of memory. Pre conditions None. Post conditions The ODNameSpaceManager object is initialized. æKY ODNameSpaceManager::Purge NameSpaceManager::Purge NameSpaceManager->Purge æT Class Method æD ODSize Purge( ODSize howMuch); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Free unused memory Inputs howMuch The amount request to free Outputs Return The amount of memory that was able to be freed. Exceptions Signalled None. Pre conditions None. Post conditions Some memory may be freed. æKY ODNameSpaceManager::UpdatePreferences NameSpaceManager::UpdatePreferences NameSpaceManager->UpdatePreferences æT Class Method æD void UpdatePreferences(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Updates the OpenDoc Preferences file to reflect changes to either the EditorKinds, EditorCategory, or ContainerSuite name mappings. Inputs None. Outputs <none> <none> Exceptions Signalled None. Pre conditions Either the EditorKinds, EditorCategory, or ContainerSuite name spaces have been changed at runtime. Post conditions EditorKinds, EditorCategory, and ContainerSuite name spaces are written out to OpenDoc Preferences. æKY ODNameSpaceManager::fNameSpaceTable NameSpaceManager::fNameSpaceTable æT Class Field æD ODObjectNameSpace fNameSpaceTable; æC æKY ODNameSpaceManager::fPreferences NameSpaceManager::fPreferences æT Class Field æD Preferences* fPreferences; æC æKY ODNameSpaceManager::fSession NameSpaceManager::fSession æT Class Field æD ODSession fSession; æC æKY ODObjectHelp ODObject Object æKL ODObject::ODObject ODObject::~ODObject ODObject::GetExtension ODObject::HasExtension ODObject::InitObject ODObject::IsEqualTo ODObject::IsInitialized ODObject::Purge ODObject::ReleaseExtension æC Basic Class Documentation This class is the common base class for most OD classes. It provides a general mechanism for extensibility through Extension objects. ODObject also provides a general memory recovery system with the Purge method. Theory of Operation ODObject does not have any real operation in it, for the most part it serves as a template. Invariants Maintained by Class ODObject can only be initialized once. If InitObject() is called again after the object is initialized, this method is a no-op and will return immediately. Any subclass of ODObject should respect this behavior as all the subclasses should call their base classes in their Init methods. æKY ODObject::ODObject Object::ODObject Object->ODObject æT Class Method æD ODObject(); æC Protection Public. Override policy Derived class can override. Derived class must call base class behavior, before derived class behavior. Basic operation Constructor of the class. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions this is an uninitialized ODObject object. æKY ODObject::~ODObject Object::~ODObject Object->~ODObject æT Class Method æD ~ODObject(); æC Protection Public. Override policy Derived class can override. Derived class must call base class behavior, after derived class behavior. Basic operation Destructor of the class. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODObject::GetExtension Object::GetExtension Object->GetExtension æT Class Method æD ODExtension* GetExtension( ODName* extensionName); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation GetExtension is intended to return the extension object with name extensionName. If the object does not have an extension object with name extensionName then an exception is raised. ODObject has no extensions and always raises an exception. Derived classes should return appropriate Extension named extensionName or call the inherited method. Inputs extensionName name of extension to get Outputs <return> the requested Extension Exceptions Signalled kODErrInvalidExtension not an extension that this object knows about Pre conditions this object has extension extensionName Post conditions return = extension extensionName æKY ODObject::HasExtension Object::HasExtension Object->HasExtension æT Class Method æD ODBoolean HasExtension( ODName* extensionName); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation HasExtension returns whether or not the object has an extension with the name extensionName. ODObject has no inherent Extensions of its own, and always returns false. Derived classes should return whether or not they return a extension named extensionName. Inputs extensionName name of extension to look for Outputs <return> whether or not this object has the given extension Exceptions Signalled None. Pre conditions extensionName is an Extension which this object has Post conditions None. æKY ODObject::InitObject Object::InitObject Object->InitObject æT Class Method æD void InitObject(); æC Protection Public. Override policy Derived class cannot override. Derived class must call base class behavior, before derived class behavior. Basic operation InitObject performs initialization operations for an object. InitObject is always called on an ODObject immediately after the constructor is called. Derived classes should do whatever is necessary to set up the internal state of their objects to be consistent with class invariants. If this method is called again after the first time on the same object, it will return immediately. Inputs None. Outputs none Exceptions Signalled None. Pre conditions None. Post conditions this is an initialized ODObject object. æKY ODObject::IsEqualTo Object::IsEqualTo Object->IsEqualTo æT Class Method æD ODBoolean IsEqualTo( ODObject object); æC Protection Public. Override policy Derived class must override. Derived class can call base class behavior, before derived class behavior. Basic operation None. Inputs object The ODObject to compare this to. Outputs <return> Whether or not the object passed in is the same as the object being dispatched to. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODObject::IsInitialized Object::IsInitialized Object->IsInitialized æT Class Method æD ODBoolean IsInitialized(); æC Protection Public. Subclasses must call this method at the beginning of their InitXXX methods to check to see they have already been initialized or not. Override policy Derived class cannot override. Derived class must call base class behavior, before derived class behavior. Basic operation None. Inputs None. Outputs <return> Whether or not this object has been initialized. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODObject::Purge Object::Purge Object->Purge æT Class Method æD ODSize Purge( ODSize size); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Purge is intended for a class to free up memory including caches until it has freed up size or more bytes or freed up all the memory it can. The number of bytes actually freed should be returned. ODObject does not allocate any memory and always return 0 bytes purged. Inputs size the number of bytes to try to purge Outputs <return> the number of bytes actually purged Exceptions Signalled None. Pre conditions None. Post conditions At least size or as many as possible bytes have been freed up by the object æKY ODObject::ReleaseExtension Object::ReleaseExtension Object->ReleaseExtension æT Class Method æD void ReleaseExtension( ODExtension* extension); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation ReleaseExtension is intended to release the extension object passed in. If the extension passed in is not one which was acquired from the object using GetExtension then an exception is raised. ODObject has no extensions and always raises an exception. Derived classes should expect an extension which was previously acquired using GetExtension, and release it. Inputs extension the extension to be released Outputs none Exceptions Signalled kODErrInvalidExtension not an extension that this object knows about Pre conditions this object has given out the given extension Post conditions the given extension is no longer guaranteed to be valid æKY ODObjectIteratorHelp ODObjectIterator ObjectIterator æKL ODObjectIterator::~ODObjectIterator ODObjectIterator::First ODObjectIterator::InitObjectIterator ODObjectIterator::IsNotComplete ODObjectIterator::Next ODObjectIterator::fNameSpace ODObjectIterator::fStrHashIterator æC Basic Class Documentation This class is an iterator for use with the ODObjectNameSpace class. It has no superclass. The platform vendor will implement. Theory of Operation This iterator follows the standard semantics of OpenDoc iterators except that two values are returned in pointer parameters: the key and the value. This class is a friend of ODObjectNameSpace. It's implementation depends heavily on the implementation of the ODObjectNameSpace class. Invariants Maintained by Class It is only meant to be used in the context of a for statement. Any other use is not guaranteed to be correct. æKY ODObjectIterator::~ODObjectIterator ObjectIterator::~ODObjectIterator ObjectIterator->~ODObjectIterator æT Class Method æD ~ODObjectIterator(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Deletes private storage. Inputs None. Outputs None Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODObjectIterator::First ObjectIterator::First ObjectIterator->First æT Class Method æD void First( ODISOStr* key, ODObject* object, ODULong* objectLength); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Return the first key/value pair. If there are no entries in the table, the values returned are garbage and the next call to IsNotComplete will return false. Note that the ODISOStr returned is a copy. The client must dispose of it. Inputs key a pointer to the key to be returned. object a pointer to the object to be returned. objectLength a pointer to the length of the object to be returned. Outputs key the key placed in the storage pointed to by key. object the object placed in the storage pointed to by object . objectLength the length of the object being returned placed in the storage pointed to by objectLength. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODObjectIterator::InitObjectIterator ObjectIterator::InitObjectIterator ObjectIterator->InitObjectIterator æT Class Method æD InitObjectIterator( ODObjectNameSpace* nameSpace); æC Protection Private. should only be called by ODObjectNameSpace Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Initialize the private member variables. Inputs nameSpace The ODObjectNameSpace over which to iterate. Outputs None Exceptions Signalled None. Pre conditions A valid ODObjectNameSpace must exist. Post conditions None. æKY ODObjectIterator::IsNotComplete ObjectIterator::IsNotComplete ObjectIterator->IsNotComplete æT Class Method æD ODBoolean IsNotComplete(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Return whether we have tried to go beyond the end of the ODObjectNameSpace entries. Inputs None Outputs <return> kODFalse if we have tried to get an entry that was beyond the end of the table, kODTrue otherwise. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODObjectIterator::Next ObjectIterator::Next ObjectIterator->Next æT Class Method æD void Next( ODISOStr* key, ODObject* object, ODULong* objectLength); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Return the next key/value pair. If there are no more entries in the table, the values returned are garbage and the next call to IsNotComplete will return false. Note that the ODISOStr returned is a copy. The client must dispose of it. Inputs key a pointer to the key to be returned. object a pointer to the object to be returned. objectLength a pointer to the length of the object to be returned. Outputs key the key placed in the storage pointed to by key. object the object placed in the storage pointed to by object . objectLength the length of the object being returned placed in the storage pointed to by objectLength . Exceptions Signalled None. Pre conditions First must be have been called! Post conditions None. æKY ODObjectIterator::fNameSpace ObjectIterator::fNameSpace æT Class Field æD ODObjectNameSpace* fNameSpace; æC Persistent form None. æKY ODObjectIterator::fStrHashIterator ObjectIterator::fStrHashIterator æT Class Field æD ODStringHashTableIterator* fStrHashIterator; æC Persistent form None. æKY ODObjectNameSpaceHelp ODObjectNameSpace ObjectNameSpace æKL ODObjectNameSpace::ODObjectNameSpace ODObjectNameSpace::~ODObjectNameSpace ODObjectNameSpace::CreateIterator ODObjectNameSpace::GetEntry ODObjectNameSpace::InitObjectNameSpace ODObjectNameSpace::Register æC Basic Class Documentation This class represents an object name space. Objects of this class are created by member functions of the ODNameSpaceManager class. The platform vendor will implement. ODObjectNameSpace is a subclass of ODNameSpace. Theory of Operation This class allows registering ODObjects witha key of type ODISOSt. Objects are hashed for quick lookup. Invariants Maintained by Class There is always a valid hash table instantiated to hold the key/value pairs. It may be empty. æKY ODObjectNameSpace::ODObjectNameSpace ObjectNameSpace::ODObjectNameSpace ObjectNameSpace->ODObjectNameSpace æT Class Method æD ODObjectNameSpace(); æC Protection Private. Only called by ODNameSpaceManager::CreateNameSpace. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Initialize an ODNameSpace class Inputs type key type (OSType, ODSLong or ODISOString). Outputs None Exceptions Signalled None. Pre conditions None. Post conditions A new ODNameSpace class will be created. æKY ODObjectNameSpace::~ODObjectNameSpace ObjectNameSpace::~ODObjectNameSpace ObjectNameSpace->~ODObjectNameSpace æT Class Method æD virtual ~ODObjectNameSpace(); æC Protection Private. Called only by ODNameSpaceManager::DeleteNameSpace. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Destroys the ODNameSpace object and any associated storage. Inputs None Outputs None Exceptions Signalled None. Pre conditions None. Post conditions Object all gone. æKY ODObjectNameSpace::CreateIterator ObjectNameSpace::CreateIterator ObjectNameSpace->CreateIterator æT Class Method æD ODObjectIterator CreateIterator(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Factory method for ODObjectIterators. Inputs None. Outputs ODObjectIterator An iterator for this name space. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODObjectNameSpace::GetEntry ObjectNameSpace::GetEntry ObjectNameSpace->GetEntry æT Class Method æD ODBoolean GetEntry( ODISOStr key, ODObject* object); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation None. Inputs key An ODISOStr hash key used to look up an object. object The ODObject returned. Outputs Return ODBoolean indicating if an entry for this key is found or not. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODObjectNameSpace::InitObjectNameSpace ObjectNameSpace::InitObjectNameSpace ObjectNameSpace->InitObjectNameSpace æT Class Method æD void InitObjectNameSpace( ODNameSpaceManager* mgr, ODNameSpace* parent, ODULong numExpectedEntries, ODISOStr name); æC Protection Private. Should only be called by ODNameSpaceManager Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Initializes the object. Inputs mgr The NameSpaceManager object that this NameSpace belongs to. parent An ODNameSpace to search if a GetValue fails in this one. numExpectedEntries The number of expected entries. name the name to give this ODNameSpace. Outputs None. Exceptions Signalled kODErrOutOfMemory Out of memory. Pre conditions None. Post conditions The object will be initialized. æKY ODObjectNameSpace::Register ObjectNameSpace::Register ObjectNameSpace->Register æT Class Method æD void Register ( ODISOStr key, ODObject object); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation None. Inputs key key object object Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODOSLTokenHelp ODOSLToken OSLToken æKL ODOSLToken::DuplicateODOSLToken æC Basic Class Documentation This class is a subclass of ODDesc that represents and OSL token. In OpenDoc, the token is owned by OpenDoc, but part editors can obtain an ODDesc to use for their private token data from an ODOSLToken using the GetUserToken method of ODNameResolver. Theory of Operation OpenDoc owns the format of the data stored in this class. This data includes information about where the token came from as well as a reference to an ODDesc. Invariants Maintained by Class Invariants for the part editor developer: the GetUserToken method of ODNameResolver will always return a valid ODDesc. æKY ODOSLToken::DuplicateODOSLToken OSLToken::DuplicateODOSLToken OSLToken->DuplicateODOSLToken æT Class Method æD æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Create a new ODOSLToken containing the same context information (where this token came from) but containing a new reference to an ODDesc that represents the "user token". Inputs None. Outputs <return> The new ODOSLToken object. Exceptions Signalled kODErrOutOfMemory Couldn't create a new object. Pre conditions None. Post conditions A new ODOSLToken object is created. æKY ODPartHelp ODPart Part æKL ODPart::ODPart ODPart::~ODPart ODPart::AbortRelinquishFocus ODPart::AdjustBorderShape ODPart::AdjustMenus ODPart::AttachSourceFrame ODPart::BeginRelinquishFocus ODPart::CanvasChanged ODPart::CanvasUpdated ODPart::ChangeKind ODPart::CloneInto ODPart::ClonePartInfo ODPart::CommitRelinquishFocus ODPart::ContainingPartPropertiesChanged ODPart::CreateEmbeddedFramesIterator ODPart::CreateLink ODPart::DisplayFrameAdded ODPart::DisplayFrameClosed ODPart::DisplayFrameConnected ODPart::DisplayFrameRemoved ODPart::DisposeActionState ODPart::DragEnter ODPart::DragLeave ODPart::DragWithin ODPart::Draw ODPart::Drop ODPart::DropCompleted ODPart::EditInLinkAttempted ODPart::EmbeddedFrameChanged ODPart::EmbeddedFrameSpec ODPart::ExternalizeKinds ODPart::FacetAdded ODPart::FacetRemoved ODPart::FocusAcquired ODPart::FocusLost ODPart::FrameShapeChanged ODPart::FulfillPromise ODPart::GeometryChanged ODPart::GetContainingPartProperties ODPart::GetPrintResolution ODPart::GetRealPart ODPart::HandleEvent ODPart::HighlightChanged ODPart::InitPart ODPart::InitPartFromStorage ODPart::IsRealPart ODPart::LinkStatusChanged ODPart::LinkUpdated ODPart::Open ODPart::PresentationChanged ODPart::ReadActionState ODPart::ReadPartInfo ODPart::RedoAction ODPart::ReleaseRealPart ODPart::RemoveEmbeddedFrame ODPart::RequestEmbeddedFrame ODPart::RequestFrameShape ODPart::RevealFrame ODPart::RevealLink ODPart::SequenceChanged ODPart::UndoAction ODPart::UsedShapeChanged ODPart::ViewTypeChanged ODPart::WriteActionState ODPart::WritePartInfo æC Basic Class Documentation Ancestors: ODPart -> ODPersistentObject -> ODRefCountObject -> ODObject. Descendants: any developer part editor implementation. ODPart is the abstract base class from which Part developers will derive the classes which implement their Part Editors. There can be no instances of ODPart itself, but there will be instances of derived classes. ODPart objectifies the structure and behavior of Parts. Each Part in a Document is represented by one instance of an ODPart. The methods defined in ODPart must be implemented by all Part Handlers. One Part Handler supplies the implementation of behavior for all Parts of a given type. Parts participate in many of the OpenDoc protocols. Devolopers of Part handlers must implement behavior for the Part's roles in all those behaviors. This provides a base structure for Parts, on which developers will construct the functionality of the Part's content. There are quite a few entry points into a Part, but many of these are fairly simple to implement. Note that in its ReleaseAll method, a Part should make sure to release all refcounted objects it is pointing to, relinquish all foci, and make sure to clear any undoactions it posted on the Undo stack. Theory of Operation Invariants Maintained by Class The part must store the ODPartWrapper object which is passed in in both the InitPart methods. This pointer will not change for the in memory lifetime of the part. The part must pass out this pointer, NOT somSelf, to any API calls which require that an ODPart be passed in. This includes InitExtension(base). The part should pass in its partWrapper as the base of all extensions it hands out. See the documentation of ODPartWrapper for more information. The fSU field (inherited from ODPersistentObject) of an ODPart is initialized to point to the Part's storage unit. This field is never nil, and cannot be changed to point at a different storage unit. Each Part may want to maintain a list of all frames in which it is displayed. The representation of this list is hidden by the API, and developers may choose whatever format works best for their implementation. A Part which can contain other parts must maintain a list of all frames embedded within it. This list contains references to frames displaying all the parts embedded in the containing part. The representation of this list is hidden by the API, and developers may choose whatever format works best for their implementation. Parts which support extensions, including a semantic interface, must manage the creation and deletion of their extension objects. In their ReleaseAll() method, Parts must call BaseRemoved() on their extensions which cannot be deleted due to positive RefCounts. æKY ODPart::ODPart Part::ODPart Part->ODPart æT Class Method æD ODPart(); æC Protection Public. Private by convention. Called only by Draft. Override policy Derived class must override. Derived class must call base class behavior. Basic operation Class constructor. This constructor is never called directly. It can only be called by invoking a constructor for a derived class. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODPart::~ODPart Part::~ODPart Part->~ODPart æT Class Method æD ~ODPart(); æC Protection Public. Private by convention. Called only by Draft. Override policy Derived class must override. Derived class must call base class behavior. Basic operation Class destructor. This destructor is never called directly. It can only be called by invoking a destructor for a derived class. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODPart::AbortRelinquishFocus Part::AbortRelinquishFocus Part->AbortRelinquishFocus æT Class Method æD void AbortRelinquishFocus( ODTypeToken focus, ODFrame* ownerFrame, ODFrame* proposedFrame); æC Protection Public. Called by Arbitrator. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation This method is called by the Arbitrator to cause the Part to back out of changes initiated by the BeginRelinquishFocus call, and resume ownership of the focus. The Part must restore itself to continue use of the focus. Inputs focus The focus type being relinquished. ownerFrame The part's frame which has the focus. proposedFrame The frame of the other part which requested the focus. Outputs None. Exceptions Signalled kODErrInvalidFocus Part doesn't own this focus. kODErrNotPrepared Part hasn't prepared to relinqush focus. kODErrInvalidFrame ownerFrame is not a display frame of this part. Pre conditions Arbitrator must have previously called ODPart::BeginRelinquishFocus(). Post conditions None. æKY ODPart::AdjustBorderShape Part::AdjustBorderShape Part->AdjustBorderShape æT Class Method æD ODShape* AdjustBorderShape( ODFrame* embeddedFrame, ODShape* shape); æC Protection Public. Called by Arbitrator. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Adjust the shape of the active frame border of an embedded frame. "shape" parameter is requested shape. Return value is that shape obscured by other contents of this part. Inputs embeddedFrame And embedded frame contained in this part, for which the border is being created. shape The starting shape for the active border of the embedded frame. Outputs <return> The shape to use for the active border, clipped by this part's content. Exceptions Signalled kODErrInvalidFrame embeddedFrame is not an embeddedFrame of this part. Pre conditions None. Post conditions None. æKY ODPart::AdjustMenus Part::AdjustMenus Part->AdjustMenus æT Class Method æD void AdjustMenus( ODFrame* frame); æC Protection Public. Called by WindowState. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Called by the WindowState just prior to MenuSelect or MenuKey to allow the Part to adjust the presentation of its menus for display. When this is called the part should enable and disable menus as appropriate for its current state. Inputs frame The display frame to adjust the menu's for. Outputs None. Exceptions Signalled kODErrInvalidFrame frame is not a display frame of this part. Pre conditions None. Post conditions None. æKY ODPart::AttachSourceFrame Part::AttachSourceFrame Part->AttachSourceFrame æT Class Method æD void AttachSourceFrame( ODFrame* frame, ODFrame* sourceFrame); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Called by the object which requested creation of a frame, immediately after creation of the frame. This associates a "source frame" with a display frame of a part. This tells the part to keep two or more of its display frames synchronized. A part will recieve this call just after a display frame has been added. Attaching a source frame should cause the display frame to look just like it, or if presentations differ, to be equivalent to it. This will cause duplication of embedded frames, and will ensure that the view in one frame is updated when content in the other is changed. Inputs frame A display frame of the part. sourceFrame Another display frame of the part. Outputs None. Exceptions Signalled kODErrInvalidFrame Either frame or sourceFrame is not a display frame of this part. Pre conditions Both frame and sourceFrame are display frames of the part. Post conditions None. æKY ODPart::BeginRelinquishFocus Part::BeginRelinquishFocus Part->BeginRelinquishFocus æT Class Method æD ODBoolean BeginRelinquishFocus( ODTypeToken focus, ODFrame* ownerFrame, ODFrame* proposedFrame); æC Protection Public. Called by Arbitrator. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Ask a part to give up ownership of a certain focus. The part will return whether is can indeed give up that focus. Upon receiving this call, a part should decide if it can give up the requested focus. If yes, it should prepare to give up the focus, which at least means remebering not to get into a state where the focus can't be given up between now and when CommitRelinquishFocus is called. Inputs focus The focus type being relinquished. ownerFrame The part's frame which has the focus. proposedFrame The frame of the other part which requested the focus. Outputs <return> Whether the part can give up the requested focus. Exceptions Signalled kODErrInvalidFocus Part doesn't own this focus. kODErrInvalidFrame ownerFrame is not a display frame of this part. Pre conditions Part owns the requested focus. Post conditions None. æKY ODPart::CanvasChanged Part::CanvasChanged Part->CanvasChanged æT Class Method æD void CanvasChanged( ODFacet* facet); æC Protection Public. Called by facet. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Notifies the part that one of its facets has been moved to image on a different canvas. The part should update any internal state necessary to comply with this. Inputs facet The facet which has a new canvas. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODPart::CanvasUpdated Part::CanvasUpdated Part->CanvasUpdated æT Class Method æD void CanvasUpdated( ODCanvas* canvas); æC Protection Public. Called by facet. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Notify the part that a canvas it owns has been updated and its contents need to be copied to its parent canvas. The part should do whatever copying it needs to do. Inputs canvas The canvas which has been updated. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODPart::ChangeKind Part::ChangeKind Part->ChangeKind æT Class Method æD void ChangeKind( ODType kind); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Ask a part to change into a new kind of content. For instance, ask an ASCII Text part to change into a Styled Text part. The part should begin using the given kind as its primary kind if it is supported. The first type of the first value in the contents property of the part's storage unit should become the given kind. Inputs kind The new kind for the part. Outputs None. Exceptions Signalled kODErrInvalidKind Part does not support that kind of content. Pre conditions The part supports kind 'kind'. Post conditions The part's primary kind is 'kind'. The first type of the first value in the contents property of the part's storage unit is 'kind'. When 'ternalized, the part uses this representation. æKY ODPart::CloneInto Part::CloneInto Part->CloneInto æT Class Method æD void CloneInto( ODDraftKey key, ODStorageUnit* storageUnit, ODStorageUnit* initiatingFrame); æC Protection Public. Mostly called by ODFrame::CloneTo. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Externalizes this ODPart into storageUnit. In order to avoid copying extra Storage Units during the deep-copy, an initiatingFrameSU may be specified. If initiatingFrameSU is not kODNULL, only those Storage Units reachable from initiatingFrameSU will be copied. If initiatingFrameSU is kODNULL, all the Storage Units reachable from this Storage Unit will be copied. Note that the actual copying may not be completed until after EndClone is finished. Inputs key ODDraftKey identifying the Clone transaction storageUnit ODStorageUnit referring to the destination Storage Unit. initiatingFrame initiatingFrame Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODPart::ClonePartInfo Part::ClonePartInfo Part->ClonePartInfo æT Class Method æD void ClonePartInfo( ODDraftKey key, ODInfoType partInfo, ODStorageUnitView* storageUnitView, ODFrame* scopeFrame); æC Protection Public. Called by ODFrame::CloneInto(). Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Clone the frame's partInfo data onto the frame's storage unit. Inputs key ODDraftKey identifying the Clone transaction partInfo The partInfo to externalize. storageUnitView A view onto a value of the frame's storage unit. scopeFrame The frame in whose scope the clone was inititated. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODPart::CommitRelinquishFocus Part::CommitRelinquishFocus Part->CommitRelinquishFocus æT Class Method æD void CommitRelinquishFocus( ODTypeToken focus, ODFrame* ownerFrame, ODFrame* proposedFrame); æC Protection Public. Called by Arbitrator. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Complete giving up ownership of a focus, which was started in Part::BeginRelinquishFocus(). Part should complete process of relinquishing ownership of focus, releasing whatever external resources are associated with that focus. Inputs focus The focus type being relinquished. ownerFrame The part's frame which has the focus. proposedFrame The frame of the other part which requested the focus. Outputs None. Exceptions Signalled kODErrInvalidFocus Part doesn't own this focus. kODErrNotPrepared Part hasn't prepared to relinqush focus. kODErrInvalidFrame ownerFrame is not a display frame of this part. Pre conditions None. Post conditions None. æKY ODPart::ContainingPartPropertiesChanged Part::ContainingPartPropertiesChanged Part->ContainingPartPropertiesChanged æT Class Method æD void ContainingPartPropertiesChanged( ODFrame* frame, ODStorageUnit* propertyUnit); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Used by my ContainingPart to inform this part of changes to content properties of its proxy for this part. Inspect "propertyUnit" for properties this part can understand. Where applicable, incorporate those properties into part's conent data. Ignore inapplicable properties, without signalling an error. Inputs frame frame propertyUnit propertyUnit Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODPart::CreateEmbeddedFramesIterator Part::CreateEmbeddedFramesIterator Part->CreateEmbeddedFramesIterator æT Class Method æD ODEmbeddedFramesIterator* CreateEmbeddedFramesIterator( ODFrame* frame); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Create an object which will iterate the frames embedded within a display frame of this part. Inputs frame A display frame of this part, or kODNULL to indicate all display frames. Outputs <return> The iterator. Caller must delete when done using. Exceptions Signalled kODErrOutOfMemory Not enough memory to allocate iterator. kODErrCannotEmbed This part does not support embedding. kODErrInvalidFrame frame is not a display frame of this part. Pre conditions None. Post conditions None. æKY ODPart::CreateLink Part::CreateLink Part->CreateLink æT Class Method æD ODLinkSource* CreateLink( ODByteArray* data); æC Protection Public. Should not be called directly by parts. Parts call ODDraft::GetLink(). Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation If a link already exists to the content identified by the data argument, return the link source object; otherwise, create a new link source object, put in the initial content and return it to the caller. The caller must decrement the reference count of the returned link source object when finished with the object. The called part must not dispose the data argument. Identify the content to be linked (by resolving the object specifier saved in the data parameter, or by some other means). Create a link source object to represent the content data. The part must maintain information about what portion of its contents have been linked to so that it may notify link clients when that data has been changed. The link source created is returned to the caller. Inputs data A description of the content object to link to, as stored by this part in a link spec. The part must not dispose this argument. Outputs <return> The link object. Exceptions Signalled kODErrCantLink Part does not support linking protocol. kODErrInvalidLinkData Could not identify content for link. kODErrOutOfMemory Not enough memory to allocate link object. Pre conditions The data identifies some portion of this part's contents. Post conditions This part maintains a link to the identified content. The caller must decrement the reference count of the returned link source object when finished with the object. æKY ODPart::DisplayFrameAdded Part::DisplayFrameAdded Part->DisplayFrameAdded æT Class Method æD void DisplayFrameAdded( ODFrame* frame); æC Protection Public. Only called by Frames during their initialization. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Tell a part to add "frame" as one of its display frames. The part must record "frame" in whatever internal structures it uses to remember its display frames. The new frame will carry suggested viewType and presentation information. The part should look at those settings, and decide if it can support them; if not, it should update those settings in the frame to reflect a default presentation it can support. Note the part must support the required set of standard viewTypes (frame, icon, small icon, thumbnail, etc.). The part will then create the appropriate partInfo data and store it in the frame. This data lets the part distinguish the frame from its other display frames, and is also a handy place to store other view-related information. Inputs frame The new frame to add. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODPart::DisplayFrameClosed Part::DisplayFrameClosed Part->DisplayFrameClosed æT Class Method æD void DisplayFrameClosed( ODFrame* frame); æC Protection Public. Called by Frame. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Tell a part one of its display frames is closing. The part should remove "frame" from its list of display frames, call Frame::Close() on any frames embedded within that frame, and release the frame. Inputs frame The frame which was closed. Outputs None. Exceptions Signalled kODErrInvalidFrame frame is not a display frame of this part. Pre conditions None. Post conditions None. æKY ODPart::DisplayFrameConnected Part::DisplayFrameConnected Part->DisplayFrameConnected æT Class Method æD void DisplayFrameConnected( ODFrame* frame); æC Protection Public. Called by Frame::GetPart(). Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation A part which has been saved in a document will later be internalized. That part will have references to its display frames, but it can be lazy and leave internalization of those frames untill they are needed. If one of those display frames is later internalized its the containing part, the frame will notify the part using this method so that the part may add the frame to its runtime list of display frames. The part should also validate relevant information in the frame, such as presentation. Inputs frame The frame which was connected. Outputs None. Exceptions Signalled kODErrInvalidFrame frame is not a display frame of this part. Pre conditions None. Post conditions None. æKY ODPart::DisplayFrameRemoved Part::DisplayFrameRemoved Part->DisplayFrameRemoved æT Class Method æD void DisplayFrameRemoved( ODFrame* frame); æC Protection Public. Called by Frame::Remove(). Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Remove a frame viewing the part. Remove the frame from my list of display frames. Make whatever other adjustments are necessary to deal with removing one of my presentations. This would include removing any frames embedded within this display frame. Inputs frame A display frame of this part. Outputs None. Exceptions Signalled kODErrInvalidFrame frame is not a display frame of this part. Pre conditions frame has no facets. Post conditions None. æKY ODPart::DisposeActionState Part::DisposeActionState Part->DisposeActionState æT Class Method æD void DisposeActionState( ODActionData actionState, ODDoneState doneState); æC Protection Public. Called by Undo. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Tell the part to dispose of the action data. Inputs actionState Information previously logged by the part to allow it to undo the action. doneState State of the undo action. It is kDone or kReDone if the action was on the document's Undo stack, and kUndone if it was on the Redo stack. Outputs None. Exceptions Signalled kODErrInvalidUndo Not an undo action of this part. Pre conditions "actionState" is an action data block previously logged by this part. Post conditions Memory for "actionState" has been reclaimed. It is no longer usable to perform undo operations. æKY ODPart::DragEnter Part::DragEnter Part->DragEnter æT Class Method æD ODBoolean DragEnter( ODDragItemIterator* dragInfo, ODFacet* facet, ODPoint where); æC Protection Public. Called by Facet. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Activate the part to track the drag. The part should display a drag target border within the facet. During drag tracking (DragEnter, DragWithin) the part should never attempt to read data from any of the storage units supplied by the iterator. The part should only inspect the type of the dragged data. If the part can accept a drop, it should return kODTrue. Otherwise, it should return kODFalse. Inputs dragInfo A drag item iterator describing the contents, and types and values of the dragged data. facet The facet of the part the drag is in. where The mouse coords of the drag, in frame coordinates. Outputs <return> boolean showing whether the Part can accept a drop. Exceptions Signalled None. Pre conditions None. Post conditions Part is ready to receive DrawWithin messages. æKY ODPart::DragLeave Part::DragLeave Part->DragLeave æT Class Method æD void DragLeave( ODFacet* facet, ODPoint where); æC Protection Public. Called by Facet. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Drag operation is complete, so deactivate part from drag tracking. Un-highlight any content previously highlighted during drag tracking. Remove drag target border. Inputs facet The facet of the part the drag is in. where The mouse coords of the drag, in frame coordinates. Outputs None. Exceptions Signalled kODErrNotDragging Part has not received a DragEnter call. Pre conditions The part was previously activated via DragEnter(). Post conditions Part is no longer active, and cannot receive further DragWithin() or Drop() messages. æKY ODPart::DragWithin Part::DragWithin Part->DragWithin æT Class Method æD ODBoolean DragWithin( ODDragItemIterator* dragInfo, ODFacet* facet, ODPoint where); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Track the drag. Provide graphical feedback about possible drop targets. Track the drag operation. Highlight appropriate content to provide feedback about potential drop targets, based on type of dragged data. Get the type information out of the dragInfo. During drag tracking (DragEnter, DragWithin) the part should never attempt to read data from any of the storage units supplied by the iterator. The part should only inspect the type of the dragged data. If the part can accept a drop, it should return kODTrue. Otherwise, it should return kODFalse. Inputs dragInfo A drag item iterator describing the contents, and types and values of the dragged data. facet The facet of the part the drag is in. where The mouse coords of the drag, in frame coordinates. Outputs <return> boolean showing whether the part can receive a drop. Exceptions Signalled kODErrNotDragging Part has not received a DragEnter call. Pre conditions The part was previously activated via DragEnter(). Post conditions None. æKY ODPart::Draw Part::Draw Part->Draw æT Class Method æD void Draw( ODFacet* facet, ODShape* invalidShape); æC Protection Public. Called by Facet. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Draw the part in the facet, updating the portion of the facet in the invalidShape. The part should draw itself on the facet's canvas. The part must examine its canvas' isDynamic flag to determine if it will be drawing on the screen or to a printer, and draw itself appropriately. Inputs facet The facet in which to draw the part. invalidShape The portion of the facet to update. In frame coordinates. Outputs None. Exceptions Signalled kODErrInvalidFrame "frame" isn't one of my display frames. Pre conditions None. Post conditions None. æKY ODPart::Drop Part::Drop Part->Drop æT Class Method æD ODDropResult Drop( ODDragItemIterator* dropInfo, ODFacet* facet, ODPoint where); æC Protection Public. Called by Facet. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Transfer the dragged data into this part. Respond to the Drop operation. This might involve moving or copying data in to the part, or some other response entirely. However, the response should use the data returned from the dropInfo iterator to perform the operation. Inputs dropInfo A drag item iterator describing the contents, and types and values of the dragged data. facet The facet of the part the drag is in. where The mouse coords of the drag, in frame coordinates. Outputs <return> <return> Exceptions Signalled kODErrNotDragging Part hasn't received a DragEnter message. Pre conditions The part was previously activated via DragEnter(). Post conditions None. æKY ODPart::DropCompleted Part::DropCompleted Part->DropCompleted æT Class Method æD void DropCompleted( ODPart* destPart, ODDropResult dropResult); æC Protection Public. Called by DragAndDrop. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation NotifyDropComplete is a peculiar method. If DragAndDrop::StartDrag is synchronous, the return code to DragAndDrop::StartDrag is the drop result. Part::DropCompleted does not need to be called. However, if it is required that DragAndDrop::StartDrag returns immediately, there needs to be a way to notify the result of the drop. Inputs destPart The destination part of the drag. dropResult The result code of the drop operation. Outputs None. Exceptions Signalled None. Pre conditions Part previously started an asynchronous drag. Post conditions None. æKY ODPart::EditInLinkAttempted Part::EditInLinkAttempted Part->EditInLinkAttempted æT Class Method æD ODBoolean EditInLinkAttempted( ODFrame* frame); æC Protection Public. Parts do not call this method directly. Parts call ODFrame::EditInLink. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Notifies the part that the user attempted to edit content in the argument embedded frame. Without making itself active, this part should display a dialog informing the user of the attempted edit to linked content, and allow the user to find the source of the link or break the link. If the user chooses to break the link, this part will change the link status of the embedded frame; the user can then retry the editing operation in the still-active frame. This method returns kODTrue if it maintains a link destination that includes the argument embedded frame. If it doesn't maintain such a link destination, it should return kODFalse. Only parts that implement linking and embedding must implement this method. The inherited implementation returns kODFalse, appropriate for parts that don't support both linking and embedding. Inputs frame The embedded frame of this part in which the edit was attempted. Outputs <return> kODTrue if the part maintains the destination of a link that includes the argument embedded frame, and kODFalse otherwise. Exceptions Signalled None. Pre conditions The argument frame is an embedded frame of this part. Post conditions None. æKY ODPart::EmbeddedFrameChanged Part::EmbeddedFrameChanged Part->EmbeddedFrameChanged æT Class Method æD void EmbeddedFrameChanged( ODFrame* frame, ODChangeID change); æC Protection Public. Called by an ODFrame object belonging to an embedded part when the frame object's ContentChanged method is called. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Notifies the containing part that content displayed in the argument embedded frame has changed. The part should call the ContentChanged method of any of its frames that would be interested in this information. This method should only be called by frame objects. The part is not responsible for passing this notification on to its containing part. The part may ignore this notification if it is uninterested in changes to embedded content. A part should wait a certain length of time (a second perhaps) before updating its display so that subsequent calls to EmbeddedFrameChanged with the same ODChangeID don’t result in multiple updates for the same change. Inputs frame The embedded frame whose contents have changed. change A unique change ID. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions The ContentChanged method of any of the part's frames may have been called and the part may have taken action to update its display. æKY ODPart::EmbeddedFrameSpec Part::EmbeddedFrameSpec Part->EmbeddedFrameSpec æT Class Method æD void EmbeddedFrameSpec( ODFrame* embeddedFrame, ODObjectSpec* spec); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Create an object specifier for the embedded frame. If this part is itself embedded, ask its containing part for the specifier for the part's display frame, then concatenate the specifier for the embedded frame to that. Inputs embeddedFrame The frame to create a specifier for. Outputs spec The frame's specifier. Exceptions Signalled kODErrInvalidFrame embeddedFrame is not an embedded frame of this part. Pre conditions None. Post conditions None. æKY ODPart::ExternalizeKinds Part::ExternalizeKinds Part->ExternalizeKinds æT Class Method æD void ExternalizeKinds( ODTypeList* kindList); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation The part should iterate through all the kinds in 'kindList', and externalize a representation for each that it supports. This call does not specify anything about the ordering of those kinds in the contents property. The part should externalize representations according to its order of fidelity, highest fidelity first. Inputs kindList The list of kinds the part should attempt to externalize. Outputs None. Exceptions Signalled None. Pre conditions The part supports a subset of the kinds in 'kindList'. Post conditions The contents property of the part has a value and representation for each kind in 'kindList' supported. æKY ODPart::FacetAdded Part::FacetAdded Part->FacetAdded æT Class Method æD void FacetAdded( ODFacet* facet); æC Protection Public. Called by a display frame of the part. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Notify the part that a facet has been added to one of its display frames. If the part does not display asynchronously and itsn't a containing part, it doesn't need to do anything in response to this call. If the part displays asynchronously, it must make sure to draw in the new facet as well. If the part has embedded frames, it must create facets for them. Inputs facet The facet added. Outputs None. Exceptions Signalled kODErrUnknownCanvasType The part is unable to render itself on the facet's canvas. Pre conditions None. Post conditions None. æKY ODPart::FacetRemoved Part::FacetRemoved Part->FacetRemoved æT Class Method æD void FacetRemoved( ODFacet* facet); æC Protection Public. Called by a display frame of this part. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Notify the part that a facet has been removed from one of its display frames. If the part does not display asynchronously and itsn't a containing part, it doesn't need to do anything in response to this call. If the part displays asynchronously, it must stop drawing in the facet. If the part has embedded frames, it must remove their facets as well. Inputs facet The facet being removed. Outputs None. Exceptions Signalled kODErrInvalidFacet facet is not a facet of this part. Pre conditions None. Post conditions None. æKY ODPart::FocusAcquired Part::FocusAcquired Part->FocusAcquired æT Class Method æD void FocusAcquired( ODTypeToken focus, ODFrame* ownerFrame); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation A notification to the part that one of its frames has acquired the specified focus. Called when a document is opened, for example. The part makes whatever response is necessary for acquiring the focus. For instance, acquiring the selection focus might cause a part to highlight its text selection. Inputs focus The focus type to acquire. ownerFrame The frame which gets the focus. Outputs None. Exceptions Signalled kODErrInvalidFocus Part cannot own this focus. kODErrInvalidFrame ownerFrame is not a display frame of this part. Pre conditions None. Post conditions None. æKY ODPart::FocusLost Part::FocusLost Part->FocusLost æT Class Method æD void FocusLost( ODTypeToken focus, ODFrame* ownerFrame); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Notify the part that a focus has unexpectedly been lost. Take whatever actions necessary to recover from having lost the focus, i.e. close connections, de-highlight selection, etc. Inputs focus The focus which was lost. ownerFrame The frame from which the focus was lost. Outputs None. Exceptions Signalled kODErrInvalidFocus Part doesn't own this focus. kODErrInvalidFrame ownerFrame is not a display frame of this part. Pre conditions None. Post conditions None. æKY ODPart::FrameShapeChanged Part::FrameShapeChanged Part->FrameShapeChanged æT Class Method æD void FrameShapeChanged( ODFrame* frame); æC Protection Public. Called by Frame::ChangeFrameShape Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Notify the part that the frame shape of one of its display frames has been changed by its containing part. The part should take whatever actions are necessary to respond to the new shape. It may need to re-layout its content, change its used shape, resize its embedded frames, or something else. It also has the option of turning around and asking the frame for a different frame shape via RequestFrameShape, though it must be able to handle the shape it is given. If the size of the frame is not sufficient, the part may ask the containing part for a continuation frame via CreatEmbeddedFrame. Inputs frame The frame being rehaped. Outputs None. Exceptions Signalled kODErrInvalidFrame frame is not a display frame of this part. Pre conditions None. Post conditions None. æKY ODPart::FulfillPromise Part::FulfillPromise Part->FulfillPromise æT Class Method æD void FulfillPromise( ODStorageUnitView *promiseSUView); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Fulfill a previously made promise by providing the actual data the promise represents. The promiseSUView is a view into the same storage unit value created by SetPromiseValue. The information about the promise is encoded in the promiseSUView in the Part Handler's own internal format. The promise data is written into the promiseSUView replacing the data stored in the Part Handler's format. When the promise was made, a record of it was kept by this part. The promiseSUView contains the part's information for that promise. The part uses the data in the promiseSUView to determine which data to move/copy. The part then writes the data into the promiseSUView. Inputs promiseSUView A view into the storage unit containing the promise value Outputs None. Exceptions Signalled kODErrInvalidPromise The part did not make this promise. Pre conditions None. Post conditions None. æKY ODPart::GeometryChanged Part::GeometryChanged Part->GeometryChanged æT Class Method æD void GeometryChanged( ODFacet* facet, ODBoolean clipShapeChanged, ODBoolean externalTransformChanged); æC Protection Public. Called by Facet. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Called by a facet of the part to inform it that the clipping shape and/or external transform of that facet has changed. The part should use the new clip shape for display from now on. Parts which display only in response to update events don't need to do anything special, provided they check the clip shape each time they draw. Parts which display asynchronously (like clocks, movies, etc.) must notice their new clipping and limit their display accordingly. Inputs facet Facet where clip shape has changed. clipShapeChanged Whether the clipShape has changed. externalTransformChanged Whether the externalTransform has changed. Outputs None. Exceptions Signalled kODErrInvalidFacet facet is not a facet of this part. Pre conditions None. Post conditions None. æKY ODPart::GetContainingPartProperties Part::GetContainingPartProperties Part->GetContainingPartProperties æT Class Method æD ODStorageUnit* GetContainingPartProperties( ODFrame* frame); æC Protection Public. Called by an embedded part. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Used by an embedded Part to ask this Containing Part of changes to content properties of the proxy for it. Create a storage unit, write properties containing part associates with the embedded frame into it, and return it. Inputs frame An embedded frame of this part. Outputs <return> A storage unit containing the container properties for the specified frame. Caller has responsibility for deallocating storage. Exceptions Signalled kODErrCannotEmbed This part does not support embedding. kODErrInvalidFrame frame is not an embedded frame of this part. Pre conditions None. Post conditions None. æKY ODPart::GetPrintResolution Part::GetPrintResolution Part->GetPrintResolution æT Class Method æD ODULong GetPrintResolution( ODFrame* frame); æC Protection Public. Called by part or app performing printing. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Return the minimum desired resolution in dots per inch this part requires for printing the contents of the specified frame. Inputs frame The frame for which the resolution is needed. Outputs <return> The desired resolution in dots per inch. Exceptions Signalled kODErrInvalidFrame frame is not a display frame of this part. Pre conditions None. Post conditions None. æKY ODPart::GetRealPart Part::GetRealPart Part->GetRealPart æT Class Method æD ODPart* GetRealPart(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation For part wrappers, this call returns the part which this wrapper encapsulates. For real parts, this call signals an error. This call should only be called if part->IsRealPart() is false. In that case, use of this getter must conform to the following constraints: Only one client at a time may have access to the real part. Therefore, clients should not hold onto a real part reference for longer than absolutely necessary - never store a real part reference in a field, and don't pass it as a parameter to other objects. When done using the real part, release it using ODPart::ReleaseRealPart(). If a second client tries to get the real part before ReleaseRealPart has been called, an error will be signaled. Note: part editors should not override this method. Inputs None. Outputs <return> undefined for real parts. the real part if this part is a wrapper. Exceptions Signalled kODPartNotWrapper GetRealPart was called on a real part. Pre conditions None. Post conditions None. æKY ODPart::HandleEvent Part::HandleEvent Part->HandleEvent æT Class Method æD ODBoolean HandleEvent( in ODEventData event, in ODFrame* frame, in ODFacet* facet, inout ODEventInfo eventInfo); æC Protection Public. Called by Dispatcher. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Return whether this part handled the event. Part responds to the UI event if it can. Inputs event A wrapper for platform-specific event data. frame The frame in which the event occured. facet The facet in which the event occurred. kODNULL for events not based on geometry, such as keyboard events. eventInfo Additional OpenDoc-specific event information. Contains an embedded frame and facet (for events like kODEvtMouseDownEmbedded), an ODPoint in local coordinates, and a "propagated" flag which is set if an embedded part chose not to handle an event, and the container has set the "propagate events" flag of the embedded frame. Outputs <return> Whether the part was able to handle the event. Exceptions Signalled kODErrInvalidFrame frame is not a display frame of this part. kODErrInvalidFacet facet is not a facet of this part. Pre conditions None. Post conditions None. æKY ODPart::HighlightChanged Part::HighlightChanged Part->HighlightChanged æT Class Method æD void HighlightChanged( ODFacet* facet); æC Protection Public. Called by Facet. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Notify the part that the highlight state of one of its facets has been changed. Adjust this part's presentation in the facet to its new highlight state. New state may be found by calling facet->GetHighlight(). Pass notification to embedded parts. Inputs frame A facet of the part. Outputs None. Exceptions Signalled kODErrInvalidFacet "facet" is not a facet of this part. Pre conditions None. Post conditions None. æKY ODPart::InitPart Part::InitPart Part->InitPart æT Class Method æD void InitPart( ODStorageUnit* storageUnit, ODPart partWrapper); æC Protection Protected. Called by Draft. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Derived class must call ODPersistentObject::InitPersistentObject(storageUnit) before derived class behaviour. Parts should not display a modal dialog in either of their InitPart… methods. Inputs storageUnit The empty storage unit to be used by this part for its primary persistent store. partWrapper The partWrapper object for this part. The part should store this pointer to its partWrapper object which it should then pass out to any api calls which require that it pass in a pointer to a part representing itself. The part should NEVER pass out a pointer to somSelf. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODPart::InitPartFromStorage Part::InitPartFromStorage Part->InitPartFromStorage æT Class Method æD void InitPartFromStorage( ODStorageUnit* storageUnit, ODPart partWrapper); æC Protection Protected. Called by Draft. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Derived class must call ODPersistentObject::InitPersistentObjectFromStorage(storageUnit) before derived class behaviour. Parts should not display a modal dialog in either of their InitPart… methods. Inputs storageUnit The storage unit which this part should read its persistent state from. partWrapper The partWrapper object for this part. The part should store this pointer to its partWrapper object which it should then pass out to any api calls which require that it pass in a pointer to a part representing itself. The part should NEVER pass out a pointer to somSelf. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODPart::IsRealPart Part::IsRealPart Part->IsRealPart æT Class Method æD æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation This call returns whether the part is an actual part, or just a part wrapper. Note: Part Editors should not override this method. They should just use the inherited implementation. Inputs None. Outputs <return> a boolean - true if this part is a real part, false if it is a wrapper Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODPart::LinkStatusChanged Part::LinkStatusChanged Part->LinkStatusChanged æT Class Method æD void LinkStatusChanged( ODFrame* frame); æC Protection Public. Call by a part's frame when that frame's ChangeLinkStatus method is called. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Frames notify their owner parts that their link status has changed whenenever ChangeLinkStatus is called. This allows the part to set the link status of any embedded frames. Inputs frame The frame of this part whose link status has changed. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions The part will call ChangeLinkStatus on any embedded frames that are involved in the link in question. æKY ODPart::LinkUpdated Part::LinkUpdated Part->LinkUpdated æT Class Method æD void LinkUpdated( ODLink* updatedLink, ODChangeID change); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation The specified link has been updated; please read and use the incoming data. Retrieve the data from the link and incorporate it into this part at the link's destination, replacing any previous content of the link. Inputs updatedLink The link which was changed. change The change id associated with the link Outputs None. Exceptions Signalled kODErrInvalidLink This isn't one of my links. Pre conditions None. Post conditions None. æKY ODPart::Open Part::Open Part->Open æT Class Method æD ODID Open( ODFrame* frame); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Open a presentation of the part in a frame in a new window. Create and open a new window. Add this part as the root part of the window. Base the presentation in the new frame on that in the old frame, or a default one if none. Inputs frame The frame which should be used as a model for the new presentation. kODNULL means the part should create a new frame and open it in the window. Outputs <return> A unique id for the new window. Exceptions Signalled kODErrInvalidFrame "frame" isn't one of my display frames. Pre conditions None. Post conditions None. æKY ODPart::PresentationChanged Part::PresentationChanged Part->PresentationChanged æT Class Method æD void PresentationChanged( ODFrame* frame); æC Protection Public. Called by Frame::ChangePresentation(). Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Notify the part that the presentation kind of one of its frames has been changed. The part should examine the new presentation kind via frame->GetPresentation(). If the part does not support that kind of presentation, it should correct the frame's presentation using frame->SetPresentation(). The part should then adjust its display in the display frame to be of the new presentation kind. Inputs frame A display frame of this part. Outputs None. Exceptions Signalled kODErrInvalidFrame "frame" isn't one of my display frames. Pre conditions None. Post conditions None. æKY ODPart::ReadActionState Part::ReadActionState Part->ReadActionState æT Class Method æD ODActionData ReadActionState( ODStorageUnitView* storageUnitView); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Internalize the undoAction data from the storage unit. Read the actionState data from a view on a StorageUnit. Allocate the memory and pass ownership of the storage to the caller. Inputs storageUnitView Where to get the action data. Outputs <return> Information previously logged by the part to allow it to undo the action. Exceptions Signalled kODErrInvalidUndo Not an undo action of this part. kODErrOutOfMemory Not enough memory to internalize data. Pre conditions None. Post conditions None. æKY ODPart::ReadPartInfo Part::ReadPartInfo Part->ReadPartInfo æT Class Method æD ODInfoType ReadPartInfo( ODFrame* frame, ODStorageUnitView* storageUnitView); æC Protection Public. Called by Frame. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Internalize the partInfo for a display frame of this part. The data for the partInfo is stored in a value in the frame's storage unit, specified by the suView param. Get the data out of the value, and place it in a block of memory. Return the memory block to the frame for it to hold. Inputs frame A display frame of this part. storageUnitView The frame's partInfo storage. Outputs <return> <return> Exceptions Signalled kODErrInvalidFrame frame is not a display frame of this part. kODErrOutOfMemory Not enough memory to allocate partInfo. Pre conditions None. Post conditions None. æKY ODPart::RedoAction Part::RedoAction Part->RedoAction æT Class Method æD void RedoAction( ODActionData actionState); æC Protection Public. Called by Undo. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Tells the part to Redo the action described by actionState. Inputs actionState Information previously logged by the part to allow it to redo the action. Outputs None. Exceptions Signalled kODErrInvalidUndo Not an undo action of this part. Pre conditions None. Post conditions None. æKY ODPart::ReleaseRealPart Part::ReleaseRealPart Part->ReleaseRealPart æT Class Method æD void ReleaseRealPart(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation For part wrappers, this call releases the part which this wrapper encapsulates. For real parts, this call signals an error. This call should only be called if part->IsRealPart() is false. In that case, the part wrapper marks its real part as available for access by another client. Note: part editors should not override this method. Inputs None. Outputs None. Exceptions Signalled kODPartNotWrapper ReleaseRealPart was called on a real part. Pre conditions None. Post conditions None. æKY ODPart::RemoveEmbeddedFrame Part::RemoveEmbeddedFrame Part->RemoveEmbeddedFrame æT Class Method æD void RemoveEmbeddedFrame( ODFrame* embeddedFrame); æC Protection Public. Called by embedded part. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Remove a frame viewing an embedded part. Called by an embedded part to indicate it no longer needs the frame to display itself. Inputs embeddedFrame embeddedFrame Outputs None. Exceptions Signalled kODErrCannotEmbed This part does not support embedding. kODErrInvalidFrame frame is not an embedded frame of this part. Pre conditions None. Post conditions None. æKY ODPart::RequestEmbeddedFrame Part::RequestEmbeddedFrame Part->RequestEmbeddedFrame æT Class Method æD ODFrame* RequestEmbeddedFrame( ODFrame* containingFrame, ODFrame* baseFrame, ODShape* frameShape, ODPart* embedPart, ODTypeToken viewType, ODTypeToken presentation, ODBoolean isOverlaid); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Ask the part to create a new frame and embed a part in it. This is only requested by embedded parts which want additional frames in which to display in the same containing part. If this part is a containing part, it should ask the draft to create a new frame, and embed the frame in its content. "baseFrame" is another display frame of the same part, already embedded in the same containing part. The frameShape param is relative to the frame coordinate system of the baseFrame. The containing part decides if it can fulfill the requests for frameShape. - if not, it can create the frame where it wants and with the shape it chooses. The containing part should assign the new frame to the same frameGroup as the baseFrame. If isOverlaid is true, the new frame should float above the part's content, and should not have to negotiate for space with the part. The viewType and presentation are just passed through to Draft::CreateFrame(). Inputs containingFrame The display frame of this part in which to embed the new frame. baseFrame A sibling frame of the frame to be created, also a display frame of the embedPart. frameShape The requested shape of the new frame. In the frame's own coordinate space. embedPart The part to embed in the new frame. viewType View type for new frame. presentation Presentation for new frame. isOverlaid Whether the new frame should float above the part's content. Outputs <return> The new frame. Exceptions Signalled kODErrCannotEmbed This part does not support embedding. kODErrOutOfMemory Not enough memory to embed a part. Pre conditions None. Post conditions None. æKY ODPart::RequestFrameShape Part::RequestFrameShape Part->RequestFrameShape æT Class Method æD ODShape* RequestFrameShape( ODFrame* embeddedFrame, ODShape* frameShape); æC Protection Public. Called by Frame::RequestFrameShape() Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation An embedded part asks to change the shape of its frame. Decide what new shape to give the embedded frame, using the requested "frameShape" as a guideline. Answer what shape is actually granted as the return value. The requestor must abide by the returned shape, though it may make further requests for different shapes or additional frames. Inputs embeddedFrame An embedded frame of this part. frameShape The requested shape, in frame coordinates of the embedded frame. Outputs <return> <return> Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODPart::RevealFrame Part::RevealFrame Part->RevealFrame æT Class Method æD ODBoolean RevealFrame( ODFrame* embeddedFrame, ODShape* revealShape); æC Protection Public. Called by embedded part. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Ask a part to make an embedded frame visible. Scroll one of this part's display frame's to make a portion of the embedded frame visible therein. If this part has no visible frames, ask a containing part to reveal one of them. If no display frames for the part currently exist, or if this part's containing frame can't reveal the display frame, open a frame in a new window. Inputs embeddedFrame An embedded frame of this part. revealShape A shape in frame coordinates of embeddedFrame. The portion of the frame to reveal. Outputs <return> A boolean indicating whether the part was able to reveal the frame. Exceptions Signalled kODErrInvalidFrame frame is not an embedded frame of this part. Pre conditions None. Post conditions None. æKY ODPart::RevealLink Part::RevealLink Part->RevealLink æT Class Method æD void RevealLink( ODLinkSource* linkSource); æC Protection Public. Called by ODLinkSource objects. Should not be called by parts. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation In some display frame for this part, select the content linked by the linkSource argument, and scroll it into view. Make that display frame the active frame. If no display frames for the part currently exist, or if this part's containing frame can't reveal the display frame, open a frame in a new window. Inputs linkSource The linked content to reveal. Outputs None. Exceptions Signalled kODErrInvalidLink This isn't one of my links. Pre conditions None. Post conditions None. æKY ODPart::SequenceChanged Part::SequenceChanged Part->SequenceChanged æT Class Method æD void SequenceChanged( ODFrame* frame); æC Protection Public. Called by containing part. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Inform the part that the sequencing of a group of its display frames has been changed. The containing part of "frame" should call this when adding a new frame to the group or re-ordering the frames in the group. A single frame of the group is passed as an argument to indicate which group of which containing frame has been changed. Inputs frame A frame in the group whose sequence has been re-ordered. Outputs None. Exceptions Signalled kODErrInvalidFrame frame is not a display frame of this part. Pre conditions None. Post conditions None. æKY ODPart::UndoAction Part::UndoAction Part->UndoAction æT Class Method æD void UndoAction( ODActionData actionState); æC Protection Public. Called by Undo. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Tells the part to Undo the action described by actionState. Inputs actionState Information previously logged by the part to allow it to undo the action. Outputs None. Exceptions Signalled kODErrInvalidUndo Not an undo action of this part. Pre conditions None. Post conditions None. æKY ODPart::UsedShapeChanged Part::UsedShapeChanged Part->UsedShapeChanged æT Class Method æD void UsedShapeChanged( ODFrame* embeddedFrame); æC Protection Public. Called by Frame::ChangeUsedShape(). Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Inform a containing part that the used shape of one of its embedded frames has changed. Containing parts which have wrapped content to the used shape of an embedded frame will need to adjust the layout of that content for the new used shape. Inputs embeddedFrame An emebedded frame of this part. Outputs None. Exceptions Signalled kODErrInvalidFrame embeddedFrame is not an embeddedFrame of this part. Pre conditions None. Post conditions None. æKY ODPart::ViewTypeChanged Part::ViewTypeChanged Part->ViewTypeChanged æT Class Method æD void ViewTypeChanged( ODFrame* frame); æC Protection Public. Called by Frame::ChangeViewType() Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Notify the part that the viewType of one of its frames has been changed. The part should examine the new view type via frame->GetViewType(). If the part does not support that kind of view type, it should correct the frame's viewType using frame->SetViewType(). Note that parts MUST support the standard set of view types (se HI spec). The part should then adjust its display in the display frame to be of the new view type. Inputs frame A display frame of this part. Outputs None. Exceptions Signalled kODErrInvalidFrame frame is not a display frame of this part. Pre conditions None. Post conditions None. æKY ODPart::WriteActionState Part::WriteActionState Part->WriteActionState æT Class Method æD void WriteActionState( ODActionData actionState, ODStorageUnitView* storageUnitView); æC Protection Public. Called by Undo. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Write out the actionState data onto a StorageUnit view. Externalize the undoAction data to the storage unit. Inputs actionState Information previously logged by the part to allow it to redo the action. storageUnitView Externalize data here. Outputs None. Exceptions Signalled kODErrInvalidUndo Not an undo action of this part. Pre conditions None. Post conditions None. æKY ODPart::WritePartInfo Part::WritePartInfo Part->WritePartInfo æT Class Method æD void WritePartInfo( ODInfoType partInfo, ODStorageUnitView* storageUnitView); æC Protection Public. Called by Frame. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Externalize the frame's partInfo data onto the frame's storage unit. Inputs partInfo The partInfo to externalize. storageUnitView A view onto a value of the frame's storage unit. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODPartWrapperHelp ODPartWrapper PartWrapper æKL ODPartWrapper::GetEditor ODPartWrapper::InitPartWrapper ODPartWrapper::UseEditor ODPartWrapper::fPart ODPartWrapper::fPartInUse æC Basic Class Documentation The ODPartWrapper class is really thin implementation which bottlenecks all calls to any part. It is used to initially create the part object by name from the editor string, and then to change the editor by deleting that part and creating another part object by name from another editor string. Superclass: ODPart Only Container Suites and the Info object should be making calls onto this object. It shows up in the API because Part editors should NEVER pass out a pointer to somSelf in their code. Instead, they should always pass out a pointer to their PartWrapper object which was passed into the part in its InitPart or InitPartFromStorage method. This also applies to extensions which parts editors create. The part editor should always pass in a pointer to its PartWrapper object as the base object for that extension. It is ok for the part editor to pass in a direct pointer to its Part object to an extension object for efficiency reasons, but only in an extension specific API. E.g. the class ODMyExtension may have a call InitMyExtension(fPartWrapper, somSelf) which then effectively calls InitExtension(fPartWrapper) and stores off the pointer to somSelf as fMyRealPart. The extension should then obey the same rule and NEVER pass out the pointer in fMyRealPart. Note that although ODPartWrapper is a subclass of ODPart, all of its ODPart methods are delegated to the same method on its fPart object. For that reason, the ODPart methods are not redocumented here. Theory of Operation A subclass of draft which is creating an ODPartWrapper should create the object, then call InitPartWrapper(editor); where editor is the ODEditor returned from the Binding object which the draft has just asked to bind a part kind to. At this point the draft should call InitPart or InitPartFromStorage on the part. Invariants Maintained by Class æKY ODPartWrapper::GetEditor PartWrapper::GetEditor PartWrapper->GetEditor æT Class Method æD ODEditor GetEditor(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation None. Inputs None. Outputs editor A getter for the subclass of part which this partwrapper object delegates part methods to. Exceptions Signalled None. Pre conditions None. Post conditions The part editor to which this partwrapper delegates its part calls to has been returned. æKY ODPartWrapper::InitPartWrapper PartWrapper::InitPartWrapper PartWrapper->InitPartWrapper æT Class Method æD void InitPartWrapper( ODEditor editor); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Creates a new ODPart subclass by name using the editor string passed in. This part is then assigned to the fPart field. Inputs editor The subclass of part which this partwrapper object should create and delegate part methods to. Outputs None. Exceptions Signalled None. Pre conditions The partwrapper object has not been initialized. Post conditions The partwrapper object has created the real ODPart subclass and is ready to go. æKY ODPartWrapper::UseEditor PartWrapper::UseEditor PartWrapper->UseEditor æT Class Method æD void UseEditor( ODEditor editor); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation None. Inputs editor The subclass of part which this partwrapper object should create and delegate part methods to. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions The part editor to which this partwrapper delegates its part calls to has been changed to the editor passed in. æKY ODPartWrapper::fPart PartWrapper::fPart æT Class Field æD ODPart* fPart; æC æKY ODPartWrapper::fPartInUse PartWrapper::fPartInUse æT Class Field æD ODBoolean fPartInUse; æC æKY ODPersistentObjectHelp ODPersistentObject PersistentObject æKL ODPersistentObject::ODPersistentObject ODPersistentObject::~ODPersistentObject ODPersistentObject::CloneInto ODPersistentObject::Externalize ODPersistentObject::GetID ODPersistentObject::GetStorageUnit ODPersistentObject::InitPersistentObject ODPersistentObject::InitPersistentObjectFromStorage ODPersistentObject::ReleaseAll ODPersistentObject::fID ODPersistentObject::fSU æC Basic Class Documentation There are a number of OD objects which require persistent storage (ODFrame, ODPart, ODLink and ODSourceLink). This functionality has been commonalized and centralized in the ODPersistentObject class and all these classes are subclasses of ODPersistentObject. All the objects from these classes are collectively known as persistent objects. Part developers should not subclass this class. They should use ODStorageUnits to store their persistent data. Platform developers may subclass this class to create persistent objects. Theory of Operation Every ODPersistentObject has a ODStorageUnit in which it stores itself persistently. When a persistent object is created for the first time, an InitXXX method is called on it (where XXX is the name of the class, e.g., InitPart). In ODXXX::InitXXX, the persistent object calls ODPersistentObject::InitPersistentObject to initialize the ODPersistentObject and then creates all its properties and values in the ODStorageUnit. When Externalize is called on the persistent object, it should write out its persistent state to the properties and values it created during InitXXX. When InitXXXFromStorage is called on the persistent object, it should read in its persistent state from the properties and values in the ODStorageUnit. Note that a persistent object should Externalize only the data which it requires for InitXXXFromStorage. Therefore, any caches or anything else which can be derived or regenerated should not be externalized. Invariants Maintained by Class InitPersistentObject is called only once on ODPersistentObject, when it is first created. After that, every time the ODPersistentObject is instantiated in memory,InitPersistentObjectFromStorage is called once. Other Persistent Properties kODPropCreateDate of type kODTime_T kODPropModDate of type kODTime_T kODPropModUser of type kODIntlText kODPropObjectType of type kODObjectType æKY ODPersistentObject::ODPersistentObject PersistentObject::ODPersistentObject PersistentObject->ODPersistentObject æT Class Method æD ODPersistentObject(); æC Protection Public. Parts and Container Apps do not call this method directly. But whenever the Part or the Container App creates a persistent object (e.g. , Frame), this method is called. Override policy Derived class must override. Derived class must call base class behavior, before derived class behavior. Basic operation None. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODPersistentObject::~ODPersistentObject PersistentObject::~ODPersistentObject PersistentObject->~ODPersistentObject æT Class Method æD ~ODPersistentObject(); æC Protection Public. Parts and Container Apps do not call this method directly. But whenever a persistent object is deleted, this method is called. Override policy Derived class can override. Derived class must call base class behavior, after derived class behavior. Basic operation release the object's storageUnit Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODPersistentObject::CloneInto PersistentObject::CloneInto PersistentObject->CloneInto æT Class Method æD void CloneInto( in ODDraftKey key, in ODStorageUnit toSU, in ODFrame scope); æC Protection Public. Every persistent object must override this method. Override policy Derived class must override. Derived class must call base class behavior, during derived class behavior. Basic operation This function clones a persistent object into the input storage unit. The persistent object should in turn clone any objects that it has references to. The scope allows the persistent object to prune out any unnecessary objects which are not contained in the specified scope. Inputs key Key for Clone operation (obtained from ODDraft::BeginClone). toSU Storage Unit which the cloned data will go. scope scope of the clone. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODPersistentObject::Externalize PersistentObject::Externalize PersistentObject->Externalize æT Class Method æD void Externalize(); æC Protection Public. Override policy Derived class can override. Derived class must call base class behavior, before derived class behavior. Basic operation Updates the moddate and modifiedUser properties of the persistent object. A derived class should write out its persistent state to the properties and values it created during InitXXX. If a derived class has no changes to write out to its persistent state, then it should NOT call base class behaviour. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODPersistentObject::GetID PersistentObject::GetID PersistentObject->GetID æT Class Method æD ODID GetID(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the ID of this object. Note that this ID is not persistent. Therefore, the same persistent object may have a different ID in every session. Inputs None. Outputs <return> ID of this object. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODPersistentObject::GetStorageUnit PersistentObject::GetStorageUnit PersistentObject->GetStorageUnit æT Class Method æD ODStorageUnit* GetStorageUnit(); æC Protection Public. Override policy Derived class cannot override. Derived class can call base class behavior, during derived class behavior. Basic operation returns the ODStorageUnit associated with the persistent object Inputs None. Outputs <return> ODStorageUnit associated with this object. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODPersistentObject::InitPersistentObject PersistentObject::InitPersistentObject PersistentObject->InitPersistentObject æT Class Method æD void InitPersistentObject( ODStorageUnit* storageUnit); æC Protection Public. Parts and Container Apps do not call this method directly. But whenever the Part or the Container App creates a persistent object (e.g. , Frame), this method is called. Override policy Derived class must override. Derived class must call base class behavior, before derived class behavior. Basic operation Creates and sets the creationDate, modDate and modifiedUser properties of the persistent object. This method is called once on a persistent object, at the beginning of its persistent lifetime. A derived class must call this method in its InitXXX method. Inputs storageUnit the storageUnit of this persistent object Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions fSU = storageUnit æKY ODPersistentObject::InitPersistentObjectFromStorage PersistentObject::InitPersistentObjectFromStorage PersistentObject->InitPersistentObjectFromStorage æT Class Method æD void InitPersistentObjectFromStorage( ODStorageUnit* storageUnit); æC Protection Public. Parts and Container Apps do not call this method directly. But whenever the Part or the Container App creates a persistent object (e.g. , Frame), this method is called. Override policy Derived class must override. Derived class must call base class behavior, before derived class behavior. Basic operation Initializes the internal fields of this object. A derived class must call this method in its InitXXXFromStorage method. Inputs storageUnit ODStorageUnit of this object Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions fSU = storageUnit æKY ODPersistentObject::ReleaseAll PersistentObject::ReleaseAll PersistentObject->ReleaseAll æT Class Method æD void ReleaseAll(); æC Protection Public. Override policy Derived class can override. Derived class must call base class behavior, after derived class behavior. Basic operation Releases all its ephemeral references to other ODRefCntObjects. All ODExtension objects which this object may have handed should also be notified with the BaseRemoved call. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions All the ephemeral references to other ODRefCntObjects are released. æKY ODPersistentObject::fID PersistentObject::fID æT Class Field æD ODID æC Persistent form None. æKY ODPersistentObject::fSU PersistentObject::fSU æT Class Field æD ODStorageUnit* æC æKY ODPlatformTypeListHelp ODPlatformTypeList PlatformTypeList æKL ODPlatformTypeList::ODPlatformTypeList ODPlatformTypeList::~ODPlatformTypeList ODPlatformTypeList::AddLast ODPlatformTypeList::Contains ODPlatformTypeList::Count ODPlatformTypeList::CreatePlatformTypeListIterator ODPlatformTypeList::InitPlatformTypeList ODPlatformTypeList::Remove ODPlatformTypeList::fList æC Basic Class Documentation ODPlatformTypeList is an ordered collection class of ODPlatformType objects. ODPlatformTypeList has no base class. Theory of Operation ODPlatformTypeList is an ordered collection of ODPlatformTypes. Users of this class can add and remove types , query the existence of a type, and get the number of types in the list. Parts may create instances of ODPlatformTypeList. Subclassing of ODPlatformTypeList is not anticipated. The main client of this class are ODClipboard and parts. The ODClipboard class uses ODPlatformTypeList as parameters to its functions. Parts can use ODPlatformTypeList to store a list of Platform Types for repeated use. ODPlatformTypeList uses OpenDoc's private collection class. Invariants Maintained by Class Every item in a ODPlatformTypeList object is unique. Therefore, a ODPlatformTypeList object contains a set of different ODPlatformTypes. A ODPlatformTypeList object can contain zero or more ODPlatformTypes. In other words, the type set can either be empty or non-empty. æKY ODPlatformTypeList::ODPlatformTypeList PlatformTypeList::ODPlatformTypeList PlatformTypeList->ODPlatformTypeList æT Class Method æD ODPlatformTypeList(); æC Protection Public. Override policy Derived class cannot override. Derived class must call base class behavior, before derived class behavior. Basic operation Class instance constructor. Inputs None. Outputs None. Exceptions Signalled kODErrOutOfMemory Could not construct this instance. Pre conditions None. Post conditions Members are initialized to a known state. æKY ODPlatformTypeList::~ODPlatformTypeList PlatformTypeList::~ODPlatformTypeList PlatformTypeList->~ODPlatformTypeList æT Class Method æD ~ODPlatformTypeList(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Class instance destructor. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions The list has been created. Post conditions None. æKY ODPlatformTypeList::AddLast PlatformTypeList::AddLast PlatformTypeList->AddLast æT Class Method æD void AddLast( ODPlatformType type); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Adds the argument platform type to the end of the list. If the platform type is already present in the list, no action is taken. Inputs type Platform type to be added. Outputs None. Exceptions Signalled kODErrOutOfMemory Could not add the argument platform type to the list. Pre conditions The list has been initialized. Post conditions The list contains the argument platform type. æKY ODPlatformTypeList::Contains PlatformTypeList::Contains PlatformTypeList->Contains æT Class Method æD ODBoolean Contains( ODPlatformType type); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Test this list for the presence of the argument platform type. Inputs type A platform type to test for inclusion in this list. Outputs <return> kODTrue if the argument platform type is in the list and kODFalse otherwise. Exceptions Signalled None. Pre conditions The list has been initialized. Post conditions None. æKY ODPlatformTypeList::Count PlatformTypeList::Count PlatformTypeList->Count æT Class Method æD ODULong Count(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation This function returns the number of platform types in the list. If the list is empty, zero is returned. Inputs None. Outputs <return> Number of platform types in the list. Exceptions Signalled None. Pre conditions The list has been initialized. Post conditions None. æKY ODPlatformTypeList::CreatePlatformTypeListIterator PlatformTypeList::CreatePlatformTypeListIterator PlatformTypeList->CreatePlatformTypeListIterator æT Class Method æD ODPlatformTypeListIterator* CreatePlatformTypeListIterator(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return an iterator for this list. The client should dispose of the iterator using the delete operator. Inputs None. Outputs <return> An iterator for this set. Exceptions Signalled kODErrOutOfMemory Could not create the iterator. Pre conditions The list has been initialized. Post conditions None. æKY ODPlatformTypeList::InitPlatformTypeList PlatformTypeList::InitPlatformTypeList PlatformTypeList->InitPlatformTypeList æT Class Method æD void InitPlatformTypeList( ODPlatformTypeList* initList); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Initializes data members and sets the list to a copy of the argument list. Inputs initList A list of ODPlatformTypes from which to initialize this object. A copy of each item in 'initList' is added to this list, in the same order as in 'initList'. A kODNULL value results in an intially empty list. Outputs None. Exceptions Signalled kODErrOutOfMemory Could not initialize the list. Pre conditions The list has been created. Post conditions The list has been initialized to copy of the argument list. æKY ODPlatformTypeList::Remove PlatformTypeList::Remove PlatformTypeList->Remove æT Class Method æD void Remove( ODPlatformType type); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Removes the argument platform type from the list. If the type is not in the list, no action is taken. Inputs type Platform type to be removed. Outputs None. Exceptions Signalled None. Pre conditions The list has been initialized. Post conditions The argument platform type is not in the list. æKY ODPlatformTypeList::fList PlatformTypeList::fList æT Class Field æD OrderedCollection* æC æKY ODPlatformTypeListIteratorHelp ODPlatformTypeListIterator PlatformTypeListIterator æKL ODPlatformTypeListIterator::ODPlatformTypeListIterator ODPlatformTypeListIterator::~ODPlatformTypeListIterator ODPlatformTypeListIterator::First ODPlatformTypeListIterator::IsNotComplete ODPlatformTypeListIterator::Next ODPlatformTypeListIterator::fIterator ODPlatformTypeListIterator::fPlatformTypeList æC Basic Class Documentation ODPlatformTypeListIterator is an iterator for the class ODPlatformTypeList. ODPlatformTypeListIterator has no base class. Theory of Operation This class is used to iterate over the elements of a ODPlatformTypeList instance in order. Iteration is forward only, from first to last. The iteration can be restarted at any time by calling the First method. If the ODPlatformTypeList instance is modified during the iteration, First or Next will throw an exception. When an exception is thrown, the iterator cannot be used further, and should be destroyed. Parts should create an ODPlatformTypeListIterator by calling the CreatePlatformTypeListIterator method of the ODPlatformTypeList instance to be iterated over. The iterator should be disposed using the delete operator. Subclassing of ODPlatformTypeListIterator is not anticipated. The implementation of ODPlatformTypeListIterator uses OpenDoc's private collection class. Invariants Maintained by Class æKY ODPlatformTypeListIterator::ODPlatformTypeListIterator PlatformTypeListIterator::ODPlatformTypeListIterator PlatformTypeListIterator->ODPlatformTypeListIterator æT Class Method æD ODPlatformTypeListIterator( ODPlatformTypeList* typeList); æC Protection Public. For use by ODPlatformTypeList only. Iterators should be created by calling ODPlatformTypeList::CreatePlatformTypeListIterator. Override policy Derived class cannot override. Derived class must call base class behavior, during derived class behavior. Basic operation Class instance constructor. Inputs typeList The list of ODPlatformTypes to iterate over. Outputs None. Exceptions Signalled kODErrOutOfMemory Could not construct this instance. Pre conditions None. Post conditions The iterator is initialized to iterate over the argument list. æKY ODPlatformTypeListIterator::~ODPlatformTypeListIterator PlatformTypeListIterator::~ODPlatformTypeListIterator PlatformTypeListIterator->~ODPlatformTypeListIterator æT Class Method æD ~ODPlatformTypeListIterator(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Class instance destructor. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions The iterator has been created. Post conditions None. æKY ODPlatformTypeListIterator::First PlatformTypeListIterator::First PlatformTypeListIterator->First æT Class Method æD ODPlatformType First(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Initiates iteration and returns the first ODPlatformType object in the list. After creating an iterator using ODPlatformTypeList::CreatePlatformTypeListIterator, call this method once, then call Next repeatedly to iterate through all items in the list. First can be called at any time to restart the iteration. Inputs None. Outputs <return> The first ODType object in the list. If the list is empty kODNULL is returned, although the client should test for completion by calling IsNotComplete. Exceptions Signalled kODErrIteratorOutOfSync The ODPlatformTypeList instance was changed during the iteration. Pre conditions None. Post conditions The first item in the list is returned, or kODNULL if the list is empty. æKY ODPlatformTypeListIterator::IsNotComplete PlatformTypeListIterator::IsNotComplete PlatformTypeListIterator->IsNotComplete æT Class Method æD ODBoolean IsNotComplete(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Test if iteration is complete. Inputs None. Outputs <return> Returns kODTrue if the last call to First or Next returned a valid ODPlatformType element, and kODFalse otherwise. Exceptions Signalled None. Pre conditions First has been called to start the iteration. Post conditions None. æKY ODPlatformTypeListIterator::Next PlatformTypeListIterator::Next PlatformTypeListIterator->Next æT Class Method æD ODPlatformType Next(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the next element from the ordered list. First should be called prior to this routine to start the iteration. Next can be called repeatedly to iterate through the remaining items in the list. IsNotComplete returns kODFalse if the preceeding call to Next did not return an item from the list. Inputs None. Outputs <return> The item in the ordered list after the last item returned by First or Next since the iteration was started. If the iteration is complete kODNULL is returned, although the client should call IsNotComplete to test for completion. Exceptions Signalled kODErrIteratorOutOfSync The ODPlatformTypeList instance was changed during the iteration. Pre conditions First has been called to start the iteration. Post conditions None. æKY ODPlatformTypeListIterator::fIterator PlatformTypeListIterator::fIterator æT Class Field æD OrderedCollectionIterator* æC æKY ODPlatformTypeListIterator::fPlatformTypeList PlatformTypeListIterator::fPlatformTypeList æT Class Field æD ODPlatformTypeList* æC æKY ODRefCntObjectHelp ODRefCntObject RefCntObject æKL ODRefCntObject::ODRefCntObject ODRefCntObject::~ODRefCntObject ODRefCntObject::GetRefCount ODRefCntObject::IncrementRefCount ODRefCntObject::InitRefCntObject ODRefCntObject::Release æC Basic Class Documentation This is the base class for all OD classes which require reference counting. Often it is convenient to share one copy of an object instead of making multiple copies of the object. When an object is shared, there needs to be a mechanism for tracking the number of references to it so that the object can be properly disposed of when there are no references to it. ODRefCntObject provides this general functionality by keeping track of the number of references to every instance. Many OpenDoc classes are subclasses of ODRefCntObject -- ODContainer, ODDocument, ODDraft, ODStorageUnit and ODWindow. However, the clients of these classes do not have to deal with the creation and destruction of the ODRefCntObject as these operations are hidden in the factory class. For example, in order to create a new ODContainer object, the client should call ODStorageSystem::CreateContainer. ODStorageSystem::CreateContainer then makes the appropriate calls to instantiate and initialize the ODContainer object. ODRefCntObject can be subclassed by part developers or platform developers. However, this class only handles ref-counting. The actual garbage collection is done by the factory object which instantiates this ODRefCntObject. For example, when the refcount of a ODContainer goes down to 0, ODStorageSystem is notified (through ODStorageSystem::ReleaseContainer) so that it can delete the ODContainer. Theory of Operation Invariants Maintained by Class The reference count of any ODRefCntObject object is always >=0. Any ODRefCntObject is valid (i.e., its pointer can be used) if its refCount > 0. æKY ODRefCntObject::ODRefCntObject RefCntObject::ODRefCntObject RefCntObject->ODRefCntObject æT Class Method æD ODRefCntObject(); æC Protection Public. Override policy Derived class can override. Derived class must call base class behavior, before derived class behavior. Basic operation Creates the object. Inputs none Outputs none Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODRefCntObject::~ODRefCntObject RefCntObject::~ODRefCntObject RefCntObject->~ODRefCntObject æT Class Method æD ~ODRefCntObject(); æC Protection Public. Override policy Derived class can override. Derived class must call base class behavior, after derived class behavior. Basic operation Deletes this object. Inputs none Outputs none Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODRefCntObject::GetRefCount RefCntObject::GetRefCount RefCntObject->GetRefCount æT Class Method æD ODULong GetRefCount(); æC Protection Public. Override policy Derived class can override. Derived class must call base class behavior, before derived class behavior. Basic operation None. Inputs None. Outputs <return> the current refcount of this object Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODRefCntObject::IncrementRefCount RefCntObject::IncrementRefCount RefCntObject->IncrementRefCount æT Class Method æD void IncrementRefCount(); æC Protection Public. Override policy Derived class can override. Derived class must call base class behavior, before derived class behavior. Basic operation Increment the reference count of this object by 1. Inputs none Outputs none Exceptions Signalled None. Pre conditions reference count of this object = x Post conditions reference count of this object = x+1 æKY ODRefCntObject::InitRefCntObject RefCntObject::InitRefCntObject RefCntObject->InitRefCntObject æT Class Method æD void InitRefCntObject(); æC Protection Public. Override policy Derived class cannot override. Derived class must call base class behavior, before derived class behavior. Basic operation Initializes this object and sets its refCount to 1. Derived class XXX must call this method inside its InitXXX method. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions refCount of this object == 1 æKY ODRefCntObject::Release RefCntObject::Release RefCntObject->Release æT Class Method æD void Release(); æC Protection Public. Override policy Derived class can override. Derived class must call base class behavior, after derived class behavior. Basic operation Decrements its reference count by 1. Inputs none Outputs none Exceptions Signalled kODErrZeroRefCount The reference count cannot be decremented because the reference count is already 0. Pre conditions reference count of this object = x, where x>0 Post conditions reference count of this object = x-1 æKY ODSemanticInterfaceHelp ODSemanticInterface SemanticInterface æKL ODSemanticInterface::ODSemanticInterface ODSemanticInterface::~ODSemanticInterface ODSemanticInterface::CallAdjustMarksProc ODSemanticInterface::CallCoercionHandler ODSemanticInterface::CallCompareProc ODSemanticInterface::CallCountProc ODSemanticInterface::CallDisposeTokenProc ODSemanticInterface::CallEventHandler ODSemanticInterface::CallGetErrDescProc ODSemanticInterface::CallGetMarkTokenProc ODSemanticInterface::CallMarkProc ODSemanticInterface::CallObjectAccessor ODSemanticInterface::CallPredispatchProc ODSemanticInterface::GetOSLSupportFlags ODSemanticInterface::InitSemanticInterface ODSemanticInterface::SetOSLSupportFlags ODSemanticInterface::UsingPredispatchProc æC Basic Class Documentation This class encapsulates the functionality necessary to call semantic event handlers and object accessors. Every ODPart instance that supports scripting must own one of these, and the ODSession object keeps a reference to an instance for the application shell. The platform vendor will implement. ODSemanticInterface is an extension class and descends from ODExtension Theory of Operation ODSemanticInterface interacts primarily with ODMessageInterface, ODNameResolver, ODSession, and ODPart. Each ODPart object supporting scripting and the ODSession will instantiate one or more of these for its own use. The application shell will use the ODSemanticInterface returned by ODSession::GetShellSemanticInterface. To send an AppleEvent to a part, the sending part calls ODMessageInterface::Send with an AppleEvent whose direct parameter is an object specifier that contains some description of the receiving part. The MessageInterface object will resolve the direct parameter to identify the destination part and then use that part's ODSemanticInterface object to dispatch the event. The ODMessageInterface object may need to use the ODSemanticInterface object of a number of parts if the resolution of the object specifier reveals the final part destination is an embedded part. The ODSemanticInterface object will walk down the hierarchy of parts from the root part to the final destination part. A part must be able to identify any of its embedded parts if requested. This is how we locate an embedded part if one is specified in the object specifier. Invariants Maintained by Class There is only one part instance for which an instance of ODSemanticInterface is an extension. æKY ODSemanticInterface::ODSemanticInterface SemanticInterface::ODSemanticInterface SemanticInterface->ODSemanticInterface æT Class Method æD ODSemanticInterface(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, before derived class behavior. Basic operation Constructor of the class. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions this is an uninitialized ODObject object. æKY ODSemanticInterface::~ODSemanticInterface SemanticInterface::~ODSemanticInterface SemanticInterface->~ODSemanticInterface æT Class Method æD ~ODSemanticInterface(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, after derived class behavior. Basic operation Destructor of the class. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODSemanticInterface::CallAdjustMarksProc SemanticInterface::CallAdjustMarksProc SemanticInterface->CallAdjustMarksProc æT Class Method æD ; æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Call the adjust marks proc for this semantic interface Inputs thePart the parts for which this is the SemanticInterface extension. newStart <See OSL documents> newStop <See OSL documents> markToken <See OSL documents> Outputs markToken <See OSL documents> Exceptions Signalled various whatever error may have been returned by the calling of the proc. Pre conditions None. Post conditions Side effects of the proc that was invoked. æKY ODSemanticInterface::CallCoercionHandler SemanticInterface::CallCoercionHandler SemanticInterface->CallCoercionHandler æT Class Method æD ; æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Call the coercion handler corresponding to the descriptorType of theODDesc and toType. Inputs thePart the parts for which this is the SemanticInterface extension. theODDesc The source ODDesc. toType The desired descriptorType. Outputs result The resulting coerced ODDesc. Exceptions Signalled various whatever error may have been returned by the coercion handler. Pre conditions None. Post conditions Side effects of the event handler that was invoked. æKY ODSemanticInterface::CallCompareProc SemanticInterface::CallCompareProc SemanticInterface->CallCompareProc æT Class Method æD ; æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Call the compare proc for this semantic interface Inputs thePart the parts for which this is the SemanticInterface extension. oper <See OSL documents> obj1 <See OSL documents> obj2 <See OSL documents> result <See OSL documents> Outputs result <See OSL documents> Exceptions Signalled various whatever error may have been returned by the calling of the proc. Pre conditions None. Post conditions Side effects of the proc that was invoked. æKY ODSemanticInterface::CallCountProc SemanticInterface::CallCountProc SemanticInterface->CallCountProc æT Class Method æD ; æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Call the count proc for this semantic interface Inputs thePart the parts for which this is the SemanticInterface extension. desiredType <See OSL documents> containerClass <See OSL documents> container <See OSL documents> result <See OSL documents> Outputs result <See OSL documents> Exceptions Signalled various whatever error may have been returned by the calling of the proc. Pre conditions None. Post conditions Side effects of the proc that was invoked. æKY ODSemanticInterface::CallDisposeTokenProc SemanticInterface::CallDisposeTokenProc SemanticInterface->CallDisposeTokenProc æT Class Method æD ; æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Call the dipose token proc for this semantic interface Inputs thePart the parts for which this is the SemanticInterface extension. unneededToken <See OSL documents> Outputs unneededToken <See OSL documents> Exceptions Signalled various whatever error may have been returned by the calling of the proc. Pre conditions None. Post conditions Side effects of the proc that was invoked. æKY ODSemanticInterface::CallEventHandler SemanticInterface::CallEventHandler SemanticInterface->CallEventHandler æT Class Method æD ; æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Call the event handler corresponding to the eventClass and eventID of theAppleEvent. Inputs thePart the parts for which this is the SemanticInterface extension. theODAppleEvent The Apple event. reply The Apple event reply. Outputs reply Any reply that it is appropriate for the part to return. Exceptions Signalled various whatever error may have been returned by the event handler. Pre conditions None. Post conditions Side effects of the event handler that was invoked. æKY ODSemanticInterface::CallGetErrDescProc SemanticInterface::CallGetErrDescProc SemanticInterface->CallGetErrDescProc æT Class Method æD ; æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Call the get error descriptor proc for this semantic interface Inputs thePart the parts for which this is the SemanticInterface extension. Outputs errDesc <See OSL documents> Exceptions Signalled various whatever error may have been returned by the calling of the proc. Pre conditions None. Post conditions Side effects of the proc that was invoked. æKY ODSemanticInterface::CallGetMarkTokenProc SemanticInterface::CallGetMarkTokenProc SemanticInterface->CallGetMarkTokenProc æT Class Method æD ; æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Call the get mark token proc for this semantic interface Inputs thePart the parts for which this is the SemanticInterface extension. dContainerToken <See OSL documents> containerClass <See OSL documents> Outputs result <See OSL documents> Exceptions Signalled various whatever error may have been returned by the calling of the proc. Pre conditions None. Post conditions Side effects of the proc that was invoked. æKY ODSemanticInterface::CallMarkProc SemanticInterface::CallMarkProc SemanticInterface->CallMarkProc æT Class Method æD ; æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Call the marking proc for this semantic interface Inputs thePart the parts for which this is the SemanticInterface extension. dToken <See OSL documents> MarkToken <See OSL documents> index <See OSL documents> Outputs markToken <See OSL documents> Exceptions Signalled various whatever error may have been returned by the calling of the proc. Pre conditions None. Post conditions Side effects of the proc that was invoked. æKY ODSemanticInterface::CallObjectAccessor SemanticInterface::CallObjectAccessor SemanticInterface->CallObjectAccessor æT Class Method æD ; æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Call the object accessor corresponding to containerClass and desiredClass. Inputs thePart the parts for which this is the SemanticInterface extension. desiredClass the type of the object. container The token describing the container for this object. containerClass The type of the container. form The keyform for selectionData. selectionData The data describing the object. value The unitialized token. Outputs value The resulting token describing the object. Exceptions Signalled various whatever error may have been returned by the object accessor. Pre conditions None. Post conditions Side effects of the object accessor that was invoked. æKY ODSemanticInterface::CallPredispatchProc SemanticInterface::CallPredispatchProc SemanticInterface->CallPredispatchProc æT Class Method æD ; æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Call the part's predispatch proc. This method is only invoked if UsingPredispatchProc has previously been called with the usingNotUsing parameter set to true. Inputs thePart the parts for which this is the SemanticInterface extension. theODAppleEvent The Apple event. reply The Apple event reply. Outputs reply Any reply that it is appropriate for the part to return. Exceptions Signalled various whatever error may have been returned by the predispatch proc. Pre conditions None. Post conditions Side effects of the predispatch proc that was invoked. æKY ODSemanticInterface::GetOSLSupportFlags SemanticInterface::GetOSLSupportFlags SemanticInterface->GetOSLSupportFlags æT Class Method æD æC Protection Public. Override policy Derived class can override. Derived class must call base class behavior, during derived class behavior. Basic operation Returns the OSL support level flags for this ODSemanticInterface. Inputs None. Outputs <return> The flags representing the level of OSL support as detailed in the documentation for the AEResolve call. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODSemanticInterface::InitSemanticInterface SemanticInterface::InitSemanticInterface SemanticInterface->InitSemanticInterface æT Class Method æD æC Protection Public. Override policy Derived class cannot override. Derived class must call base class behavior, before derived class behavior. Basic operation Do initialization that can fail. Inputs base the ODPart* for which this is an extension. Outputs None. Exceptions Signalled kODErrOutOfMemory Not enough memory to initialize object. Pre conditions None. Post conditions Object is completely initialized. æKY ODSemanticInterface::SetOSLSupportFlags SemanticInterface::SetOSLSupportFlags SemanticInterface->SetOSLSupportFlags æT Class Method æD æC Protection Public. Override policy Derived class can override. Derived class must call base class behavior, during derived class behavior. Basic operation Sets the flags that determine the level of OSL support that this ODSemanticInterface provides. Inputs flags The flags representing the level of OSL support as detailed in the documentation for the AEResolve call. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODSemanticInterface::UsingPredispatchProc SemanticInterface::UsingPredispatchProc SemanticInterface->UsingPredispatchProc æT Class Method æD æC Protection Public. Override policy Derived class can override. Derived class must call base class behavior, during derived class behavior. Basic operation Notify the extension that you do/do not want to receive predispatch calls. Inputs usingNotUsing Whether or not you want CallPredispatchProc to be called every time the process is sent an AppleEvent. Outputs <return> The part represented by the token, or kODNull if the token does not represent an embedded part. Exceptions Signalled None. Pre conditions None. Post conditions The ODBaseSemanticInterface is registered as using or not using a predispatch proc. æKY ODSessionHelp ODSession Session æKL ODSession::ODSession ODSession::~ODSession ODSession::GetArbitrator ODSession::GetBinding ODSession::GetClipboard ODSession::GetDispatcher ODSession::GetDragAndDrop ODSession::GetInfo ODSession::GetLinkManager ODSession::GetMessageInterface ODSession::GetNameResolver ODSession::GetNameSpaceManager ODSession::GetSemanticInterface ODSession::GetShellSemtInterface ODSession::GetStorageSystem ODSession::GetTranslation ODSession::GetType ODSession::GetUndo ODSession::GetUserName ODSession::GetWindowState ODSession::InitSession ODSession::Purge ODSession::RemoveEntry ODSession::SetArbitrator ODSession::SetBinding ODSession::SetClipboard ODSession::SetDispatcher ODSession::SetDragAndDrop ODSession::SetInfo ODSession::SetLinkManager ODSession::SetMessageInterface ODSession::SetNameResolver ODSession::SetNameSpaceManager ODSession::SetShellSemtInterface ODSession::SetStorageSystem ODSession::SetTranslation ODSession::SetUndo ODSession::SetWindowState ODSession::Tokenize ODSession::UniqueChangeID ODSession::fArbitrator ODSession::fClipboard ODSession::fDispatcher ODSession::fDragAndDrop ODSession::fLinkManager ODSession::fMessageInterface ODSession::fNameResolver ODSession::fSemanticInterface ODSession::fShellSemtInterface ODSession::fStorage ODSession::fSymbols ODSession::fTokenTable ODSession::fTranslation ODSession::fUndo ODSession::fWindowState æC Basic Class Documentation This class encapsulates access to OpenDoc globals as well as initialization and shutdown of the OpenDoc environment. It calls the constructor for a number of unique global objects and must have access to those classes' constructors. Platform vendor should implement. ODSession is a subclass of ODObject. Note that ODSession is a subclass of ODBaseSession. This class contains some of the public API available to developers. However, the existence of ODBaseSession is an artifact of the C++ language. Please use this document as a guide to the OpenDoc session-level functionality. Theory of Operation Initialization of OpenDoc is through the function OpenODSession and shutdown through the function ODSession::Close. OpenODSession creates a number of global objects, saving references to them, and ODSession::Close destroys these objects. Accessor functions return the value of the cached references. Invariants Maintained by Class All member variables always contain valid references. æKY ODSession::ODSession Session::ODSession Session->ODSession æT Class Method æD ODSession(); æC Protection Private. to the function OpenODSession . Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Creates a number of global unique objects. Caches references to these objects. Inputs None Outputs None Exceptions Signalled None Pre conditions None. Post conditions The ODSession object is initialized. æKY ODSession::~ODSession Session::~ODSession Session->~ODSession æT Class Method æD virtual ~ODSession(); æC Protection Private. to the function ODSession::Close. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Deletes all the objects created in the constructor Inputs None Outputs None Exceptions Signalled None Pre conditions None. Post conditions ODSysmtemInterface object is destroyed. æKY ODSession::GetArbitrator Session::GetArbitrator Session->GetArbitrator æT Class Method æD virtual ODArbitrator* GetArbitrator(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Return reference to the global object. Inputs None Outputs Return Reference to the global object Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::GetBinding Session::GetBinding Session->GetBinding æT Class Method æD ; æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Return reference to the global object. Inputs None Outputs Return Reference to the global object Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::GetClipboard Session::GetClipboard Session->GetClipboard æT Class Method æD virtual ODClipboard* GetClipboard(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Return reference to the global object. Inputs None Outputs Return Reference to the global object Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::GetDispatcher Session::GetDispatcher Session->GetDispatcher æT Class Method æD virtual ODDispatcher* GetDispatcher(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Return reference to the global object. Inputs None Outputs Return Reference to the global object Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::GetDragAndDrop Session::GetDragAndDrop Session->GetDragAndDrop æT Class Method æD virtual ODDragAndDrop* GetDragAndDrop(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Return reference to the global object. Inputs None Outputs Return Reference to the global object Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::GetInfo Session::GetInfo Session->GetInfo æT Class Method æD ; æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Return reference to the global object. Inputs None Outputs Return Reference to the global object Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::GetLinkManager Session::GetLinkManager Session->GetLinkManager æT Class Method æD ODLinkManager* GetLinkManager(); æC Protection Public. Should not be called by parts. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Return reference to the global object. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODSession::GetMessageInterface Session::GetMessageInterface Session->GetMessageInterface æT Class Method æD virtual ODMessageInterface* GetMessageInterface(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Return reference to the global object. Inputs None Outputs Return Reference to the global object Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::GetNameResolver Session::GetNameResolver Session->GetNameResolver æT Class Method æD ; æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Return reference to the global object. Inputs None Outputs Return Reference to the global object Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::GetNameSpaceManager Session::GetNameSpaceManager Session->GetNameSpaceManager æT Class Method æD ODNameSpaceManager* GetNameSpaceManager(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Return reference to the global object. Inputs None Outputs Return Reference to the global object Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::GetSemanticInterface Session::GetSemanticInterface Session->GetSemanticInterface æT Class Method æD virtual ODSemanticInterface* GetSemanticInterface(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns cached reference to system's ODSemanticInterface. This is not a unique object. Other OpenDoc object may own one or more instances of ODSemanticInterface. This object can be used to install system level event handlers and object accessors. Inputs None Outputs Return Reference to system's copy of the the ODSemanticInterface. Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::GetShellSemtInterface Session::GetShellSemtInterface Session->GetShellSemtInterface æT Class Method æD ODSemanticInterface* GetShellSemtInterface(); æC Protection Public. Only the shell should use this method. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Return a reference to an ODSemanticInterface object that the application shell can use. Inputs None. Outputs Return a reference to the shell's ODSemanticInterface object Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::GetStorageSystem Session::GetStorageSystem Session->GetStorageSystem æT Class Method æD virtual ODStorageSystem* GetStorageSystem(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Return reference to the global object. Inputs None Outputs Return Reference to the global object Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::GetTranslation Session::GetTranslation Session->GetTranslation æT Class Method æD virtual ODTranslation* GetTranslation(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Return reference to the global object. Inputs None Outputs Return Reference to the global object Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::GetType Session::GetType Session->GetType æT Class Method æD ODBoolean GetType( ODTypeToken token, ODType* type); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Get the ODType corresponding to the given ODTypeToken. If the token does not exist, kODFalse is retuned. kODTrue is returned otherwise. Inputs token The ODTypeToken of interest. Outputs Return Whether the type for the given token exists in the token table. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODSession::GetUndo Session::GetUndo Session->GetUndo æT Class Method æD virtual ODUndo* GetUndo(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Return reference to the global object. Inputs None Outputs Return Reference to the global object Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::GetUserName Session::GetUserName Session->GetUserName æT Class Method æD æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the string representing the current user of the document. Inputs None. Outputs <return> <return> Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODSession::GetWindowState Session::GetWindowState Session->GetWindowState æT Class Method æD virtual ODWindowState* GetWindowState(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Return reference to the global object. Inputs None Outputs Return Reference to the global object Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::InitSession Session::InitSession Session->InitSession æT Class Method æD void InitSession(); æC Protection Private. Should only be called by OpenODSession Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Creates and initializes global objects. Inputs None Outputs None Exceptions Signalled Others… Subsystems. Pre conditions None. Post conditions The ODSession object will be fully initialized. æKY ODSession::Purge Session::Purge Session->Purge æT Class Method æD ODSize Purge( ODSize size); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Make memory available. Inputs size The size requested to be freed. Outputs Return The amount of memory that was able to be freed. Exceptions Signalled None Pre conditions None. Post conditions Some memory may be freed for use. æKY ODSession::RemoveEntry Session::RemoveEntry Session->RemoveEntry æT Class Method æD void RemoveEntry( ODType type); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Remove an ODType from the type/token table. Any unique ID previously generated for this type can now be reused. No error is signalled if the type was not previously tokenized. Inputs type The ODType to be removed from the type/token table. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions The type/token pair corresponding to this type will be removed from the token table. æKY ODSession::SetArbitrator Session::SetArbitrator Session->SetArbitrator æT Class Method æD void SetArbitrator( ODArbitrator* object); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Set global object reference. Inputs object The object to replace the existing object. Outputs None. Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::SetBinding Session::SetBinding Session->SetBinding æT Class Method æD void SetBinding( ODBinding* object); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Set global object reference. Inputs object The object to replace the existing object. Outputs None. Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::SetClipboard Session::SetClipboard Session->SetClipboard æT Class Method æD void SetClipboard( ODClipboard* object); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Set global object reference. Inputs object The object to replace the existing object. Outputs None. Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::SetDispatcher Session::SetDispatcher Session->SetDispatcher æT Class Method æD void SetDispatcher( ODDispatcher* object); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Set global object reference. Inputs object The object to replace the existing object. Outputs None. Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::SetDragAndDrop Session::SetDragAndDrop Session->SetDragAndDrop æT Class Method æD void SetDragAndDrop( ODDragAndDrop* object); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Set global object reference. Inputs object The object to replace the existing object. Outputs None. Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::SetInfo Session::SetInfo Session->SetInfo æT Class Method æD void SetInfo( ODInfo* object); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Set global object reference. Inputs object The object to replace the existing object. Outputs None. Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::SetLinkManager Session::SetLinkManager Session->SetLinkManager æT Class Method æD void SetLinkManager( ODLinkManager* object); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Set global object reference. Inputs object The object to replace the existing object. Outputs None. Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::SetMessageInterface Session::SetMessageInterface Session->SetMessageInterface æT Class Method æD void SetMessageInterface( ODMessageInterface* object); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Set global object reference. Inputs object The object to replace the existing object. Outputs None. Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::SetNameResolver Session::SetNameResolver Session->SetNameResolver æT Class Method æD void SetNameResolver( ODNameResolver* object); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Set global object reference. Inputs object The object to replace the existing object. Outputs None. Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::SetNameSpaceManager Session::SetNameSpaceManager Session->SetNameSpaceManager æT Class Method æD void SetNameSpaceManager( ODNameSpaceManager* object); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Set global object reference. Inputs object The object to replace the existing object. Outputs None. Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::SetShellSemtInterface Session::SetShellSemtInterface Session->SetShellSemtInterface æT Class Method æD void SetSemanticInterface( ODSemanticInterface* object); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Set global object reference. Inputs object The object to replace the existing object. Outputs None. Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::SetStorageSystem Session::SetStorageSystem Session->SetStorageSystem æT Class Method æD void SetStorageSystem( ODStorageSystem* object); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Set global object reference. Inputs object The object to replace the existing object. Outputs None. Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::SetTranslation Session::SetTranslation Session->SetTranslation æT Class Method æD void SetTranslation( ODTranslation* object); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Set global object reference. Inputs object The object to replace the existing object. Outputs None. Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::SetUndo Session::SetUndo Session->SetUndo æT Class Method æD void SetUndo( ODUndo* object); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Set global object reference. Inputs object The object to replace the existing object. Outputs None. Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::SetWindowState Session::SetWindowState Session->SetWindowState æT Class Method æD void SetWindowState( ODWindowState* object); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Set global object reference. Inputs object The object to replace the existing object. Outputs None. Exceptions Signalled None Pre conditions None. Post conditions None. æKY ODSession::Tokenize Session::Tokenize Session->Tokenize æT Class Method æD ODTypeToken Tokenize( ODType type); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns a unique ODTypeToken for a given ODType. Original token is returned if type has been previously tokenized. Inputs type The ODType to register Outputs Return The unique token for this type. kODNullTypeToken is returned if an error occurs. Exceptions Signalled kODErrOutOfMemory out of memory Pre conditions None. Post conditions A new unique token is generated if the type has not yet been tokenized. æKY ODSession::UniqueChangeID Session::UniqueChangeID Session->UniqueChangeID æT Class Method æD ODChangeID UniqueChangeID(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Return a change identification unique to this session and unlikely to be repeated on the network. Inputs None. Outputs <result> A unique change identification. Exceptions Signalled None. Pre conditions None. Post conditions Result is an identifier with a high likelyhood of uniqueness. æKY ODSession::fArbitrator Session::fArbitrator æT Class Field æD ODArbitrator* fArbitrator; æC Persistent form None. æKY ODSession::fClipboard Session::fClipboard æT Class Field æD ODClipboard* fClipboard; æC Persistent form None. æKY ODSession::fDispatcher Session::fDispatcher æT Class Field æD ODDispatcher* fDispatcher; æC Persistent form None. æKY ODSession::fDragAndDrop Session::fDragAndDrop æT Class Field æD ODDragAndDrop* fDragAndDrop; æC Persistent form None. æKY ODSession::fLinkManager Session::fLinkManager æT Class Field æD ODLinkManager* fLinkManager; æC æKY ODSession::fMessageInterface Session::fMessageInterface æT Class Field æD ODMessageInterface* fMessageInterface; æC Persistent form None. æKY ODSession::fNameResolver Session::fNameResolver æT Class Field æD ODNameResolver* fNameResolver; æC Persistent form None. æKY ODSession::fSemanticInterface Session::fSemanticInterface æT Class Field æD ODSemanticInterface* fSemanticInterface; æC Persistent form None. æKY ODSession::fShellSemtInterface Session::fShellSemtInterface æT Class Field æD ODSemanticInterface* fShellSemtInterface æC Persistent form None. æKY ODSession::fStorage Session::fStorage æT Class Field æD ODStorage* fStorage; æC Persistent form None. æKY ODSession::fSymbols Session::fSymbols æT Class Field æD ODSymbols* fSymbols; æC Persistent form None. æKY ODSession::fTokenTable Session::fTokenTable æT Class Field æD ODTokenTable* fTokenTable; æC Persistent form None. æKY ODSession::fTranslation Session::fTranslation æT Class Field æD ODTranslation* fTranslation; æC Persistent form None. æKY ODSession::fUndo Session::fUndo æT Class Field æD ODUndo* fUndo; æC Persistent form None. æKY ODSession::fWindowState Session::fWindowState æT Class Field æD ODWindowState* fWindowState; æC æKY ODSettingsExtensionHelp ODSettingsExtension SettingsExtension æKL ODSettingsExtension::InitSettingsExtension ODSettingsExtension::ShowSettings æC Basic Class Documentation The part info dialog only supports the standard properties which all OpenDoc parts have. In order to allow the user to access editor specific properties on a part, part editors can support and implement an ODSettingsExtension which will cause a (Settings…) button to show up in the lower left hand corner of the Part Info dialog. When the user clicks this button, OpenDoc calls ShowSettings on the part's ODSettingsExtension. This gives the part editor a chance to put up an additional dialog to allow editing of part specific settings. Superclass: ODExtension It is intended that Part Editor developers subclass this class. Theory of Operation In the implementation of the ShowPartFrameInfo method of the Info object, it checks to see if the part which the info is being shown about supports the ODSettingsExtension. If it does, a (Settings…) in the lower left corner of the dialog is made visible. If the user clicks this button, the code gets the ODSettingsExtension of the part editor and tells it to ShowSettings. Invariants Maintained by Class æKY ODSettingsExtension::InitSettingsExtension SettingsExtension::InitSettingsExtension SettingsExtension->InitSettingsExtension æT Class Method æD void InitSettingsExtension( ODPart* base); æC Protection Public. Override policy Derived class must override. Derived class must call base class behavior, before derived class behavior. Basic operation This method calls its superclasses' InitExtension method and initializes the settingsExtension object. Inputs base The base object for this extension. Outputs None. Exceptions Signalled None. Pre conditions The settingsextension object is not initialized Post conditions The settingsextension object is initialized and is ready to execute other methods. æKY ODSettingsExtension::ShowSettings SettingsExtension::ShowSettings SettingsExtension->ShowSettings æT Class Method æD void ShowSettings( ODFacet* facet); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior, during derived class behavior. Basic operation This is an abstract method which must be implemented by a subclass of ODSettingsExtension. It should bring up a modal dialog which permits the user to edit editor specific properties on this part. The Settings dialog MUST be modal and displayed using ModalDialog() on the Macintosh. Inputs facet The facet which was passed into the ShowPartFrameInfo method of the Info object which is now calling this method. This is the facet which indicates which monitor to display the settings dialog, and the facet's frame and it's part indicate which part's properties should be displayed and edited. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions The settingsExtension object has had a chance to let the user edit the editor specific properties on this part. æKY ODShapeHelp ODShape Shape æKL ODShape::ContainsPoint ODShape::Copy ODShape::CopyFrom ODShape::CopyPolygon ODShape::GetBoundingBox ODShape::GetGeometryMode ODShape::GetGXShape ODShape::GetPlatformShape ODShape::GetQDRegion ODShape::HasGeometry ODShape::InitShape ODShape::Intersect ODShape::InverseTransform ODShape::IsEmpty ODShape::IsRectangular ODShape::IsSameAs ODShape::NewShape ODShape::Outset ODShape::ReadShape ODShape::Reset ODShape::SetGeometryMode ODShape::SetGXShape ODShape::SetPlatformShape ODShape::SetPolygon ODShape::SetQDRegion ODShape::SetRectangle ODShape::somInit ODShape::somUninit ODShape::Subtract ODShape::Transform ODShape::Union ODShape::WriteShape ODShape::fMode ODShape::fShape æC Basic Class Documentation Base class: ODObject. This class represents a geometric shape or area of a document. It is mostly used to define an ODFrame's and ODFacet's various shapes for frame negotiation, clipping, hit testing, etc. More background information can be found in the ODFrame and ODFacet class documentation. Theory of Operation An ODShape starts out life empty. Public methods are defined to get and set the shape data in various formats, both universal (rectangle, polygon) and platform specific (QuickDraw Region, QuickDraw GX shape, …) The most universal representation of a shape is a polygon, and this is how it is stored in a document. However, some platform-specific shape types (like Regions) — which are needed for ephemeral shapes such as clipping regions that are closely tied to the native windowing system — may not be representable as polygons. A shape has a Geometry Mode which governs whether it is required to maintain a polygonal representation, or whether this representation can be abandoned for the sake of efficiency. Invariants Maintained by Class An ODShape is an “envelope” that points to a private ODRealShape object. Most of the calls to ODShape are delegated to the ODRealShape. There are various subclasses of the abstract ODRealShape class; these represent rectangles, polygons, QuickDraw Regions, and QuickDraw GX shapes. During an ODShape's life it may use various different ODRealShapes to represent its data, depending on the particular shape. The client does not need to worry about this. æKY ODShape::ContainsPoint Shape::ContainsPoint Shape->ContainsPoint æT Class Method æD ODBoolean ContainsPoint( ODPoint point); æC Protection Public. No restrictions. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Determines whether the shape contains a point. Inputs point ODPoint given in this shape's coordinate space. Outputs <return> kODTrue if aPoint is in this shape, kODFalse otherwise. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODShape::Copy Shape::Copy Shape->Copy æT Class Method æD ODShape* Copy(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Returns a copy of this shape. This is a factory method for shapes: do not call "new ODShape" yourself. The new shape is a deep copy: it does not share any data with the original and both can be modified independently. Inputs None. Outputs <return> A new shape identical to the receiver Exceptions Signalled kODErrOutOfMemory Pre conditions None. Post conditions None. æKY ODShape::CopyFrom Shape::CopyFrom Shape->CopyFrom æT Class Method æD void CopyFrom( ODShape* sourceShape); æC Protection Public. No restrictions. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Makes this shape an exact copy of sourceShape. This is a deep copy: the shape does not share any data with sourceShape and both can be modified independently. Inputs sourceShape Pointer to another ODShape object. Caller's storage responsability. Outputs None. Exceptions Signalled kODErrOutOfMemory Not enough memory to copy shape data. Pre conditions None. Post conditions Shape is identical to sourceShape. æKY ODShape::CopyPolygon Shape::CopyPolygon Shape->CopyPolygon æT Class Method æD ODPolygon CopyPolygon(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Returns a new ODPolygon describing this shape. Caller is responsible for deleting this polygon afterward. Not all shapes may have a polygonal representation so this call may fail with a kODErrNoGeometry exception. You can call HasGeometry first to check. Some shapes (i.e. curves) may be only approximated by a polygon. Don't expect it to be 100% exact. Inputs None. Outputs <return> Pointer to a new ODPolygon. Exceptions Signalled kODErrOutOfMemory kODErrNoGeometry Shape cannot be described as a polygon. Pre conditions Shape has geometry. Post conditions None. æKY ODShape::GetBoundingBox Shape::GetBoundingBox Shape->GetBoundingBox æT Class Method æD void GetBoundingBox( ODRect *bounds ); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Returns the bounding box of this shape (the smallest rectangle that contains this shape.) After the call the ODRect pointed to by bounds will be set to the bounding box. Inputs bounds Pointer to the ODRect into which to copy the bounding box. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions *bounds is set to the shape's bounding box. æKY ODShape::GetGeometryMode Shape::GetGeometryMode Shape->GetGeometryMode æT Class Method æD ODGeometryMode GetGeometryMode(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Returns the current geometry mode of this shape. See the discussion of the fMode field. Inputs None. Outputs <return> Shape's geometry mode. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODShape::GetGXShape Shape::GetGXShape Shape->GetGXShape æT Class Method æD inline gxShape GetGXShape (); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation This is a Mac-specific inline method that returns a QuickDraw GX shape equivalent to the shape. The caller should not modify this shape, but should dispose it when finished with it. This call is identical to: (gxShape)this->GetPlatformShape(kODQuickDrawGX); Inputs None. Outputs <return> Reference to a GX shape. Cannot be modified but should be disposed by caller. Exceptions Signalled None. Pre conditions QuickDraw GX is installed. Post conditions None. æKY ODShape::GetPlatformShape Shape::GetPlatformShape Shape->GetPlatformShape æT Class Method æD ODPlatformShape GetPlatformShape( ODGraphicsSystem ); æC Protection Public. No restrictions. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Returns the data of this shape object, for a particular graphics system. The format of the data is graphics system dependent. Whether or not this data is a copy depends on the implementation and the graphics system. For kODQuickDraw, the data is a RgnHandle, which belongs to the shape and should not be modified or disposed by the caller. For kODQuickDrawGX, it's a gxShape. The caller should not modify the shape, but should dispose it (i.e. lower its ref-count) when done. Inputs ODGraphicsSystem The graphics system of the data you want to get. Outputs <return> Graphics-system-specific shape data (see method description) Exceptions Signalled kODErrInvalidGraphicsSystem Graphics system unknown or not installed. Pre conditions None. Post conditions None. æKY ODShape::GetQDRegion Shape::GetQDRegion Shape->GetQDRegion æT Class Method æD inline RgnHandle GetQDRegion (); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation This is a Mac-specific inline method that returns a Region equivalent to the shape. The region is owned by the shape and the caller must not modify or dispose it. This call is identical to: (RgnHandle)this->GetPlatformShape(kODQuickDraw); Inputs None. Outputs <return> QD Region representing the shape Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODShape::HasGeometry Shape::HasGeometry Shape->HasGeometry æT Class Method æD ODBoolean HasGeometry(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Returns true if the shape's geometric information (i.e. its polygonal shape) is accessible. A call to CopyPolygon is valid only if this is true. What makes a shape non-geometric is implementation specific. See SetGeometryMode. Inputs None. Outputs <result> kODTrue if the shape can be represented as a polygon, else kODFalse. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODShape::InitShape Shape::InitShape Shape->InitShape æT Class Method æD void InitShape(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation InitShape initializes a freshly created ODShape object. It sets it to an empty shape, i.e. one with zero area. This method is called by all factory methods that create shapes; clients should not need to use it. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions Shape has been created (by “new ODShape”) but no other methods have been called on it. Post conditions Shape is initialized and empty. æKY ODShape::Intersect Shape::Intersect Shape->Intersect æT Class Method æD void Intersect( ODShape* sectShape); æC Protection Public. No restrictions. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Intersects this shape with sectShape. This shape becomes the intersection; fShape is unchanged. Inputs sectShape another ODShape object to intersect the receiver with. Outputs None. Exceptions Signalled kODErrOutOfMemory not enough memory to intersect shapes. kODErrNoGeometry Geometry mode is kODNeedsGeometry, but diffShape has no geometry. Pre conditions None. Post conditions This shape becomes the intersection of sectShape and its previous shape. sectShape is unchanged. æKY ODShape::InverseTransform Shape::InverseTransform Shape->InverseTransform æT Class Method æD ODShape* InverseTransform( ODTransform* transform); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Runs this shape through the opposite of the given transform. This is the inverse operation of ODShape::Transform. Shapes with no geometry may not be transformable except by simple offsets. Inputs transform ODTransform to apply the inverse of. Outputs <result> The receiver. Exceptions Signalled kODErrNoShapeGeometry Shape does not have enough geometric information to be transformed in this way. Pre conditions Transform is non-singular (i.e. invertible) Post conditions Shape is transformed. æKY ODShape::IsEmpty Shape::IsEmpty Shape->IsEmpty æT Class Method æD ODBoolean IsEmpty(); æC Protection Public. No restrictions Override policy Derived class can override. Derived class can call base class behavior. Basic operation Returns true if the shape is empty (has no area). Inputs None. Outputs <result> kODTrue if the shape is empty, otherwise kODFalse. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODShape::IsRectangular Shape::IsRectangular Shape->IsRectangular æT Class Method æD ODBoolean IsRectangular(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Returns kODTrue if the shape is a rectangle, kODFalse otherwise. Empty shapes are rectangular. Inputs None. Outputs <result> kODTrue if the shape is rectangular, else kODFalse Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODShape::IsSameAs Shape::IsSameAs Shape->IsSameAs æT Class Method æD ODBoolean IsSameAs( ODShape* compareShape); æC Protection Public. No restrictions. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Returns true if the two shapes are identical (describe the same area.) Warning: This may return false if the shapes are ever so slightly different due to rounding errors. Inputs compareShape shape to compare against. Outputs <return> kODTrue if shapes are equivalent or equal, kODFalse otherwise. Exceptions Signalled kODErrOutOfMemory not enough memory to compare shapes. Pre conditions None. Post conditions None. æKY ODShape::NewShape Shape::NewShape Shape->NewShape æT Class Method æD ODShape* NewShape(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Returns a new, initialized and empty shape object. This is a "factory method" for creating shapes; do not call "new ODShape" yourself. The new shape has the same geometry mode as the original shape. This is important for things like clip shapes and frame shapes, since the wrong choice of geometry mode can reduce performance onscreen or cause low-resolution output on a printer. Inputs None. Outputs <return> The new ODShape (or NULL if there was an error.) Exceptions Signalled kODErrOutOfMemory Not enough memory to create a new shape. Pre conditions None. Post conditions None. æKY ODShape::Outset Shape::Outset Shape->Outset æT Class Method æD void Outset( ODCoordinate distance ); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Modifies the shape by moving its boundary outwards (away from its interior) by the given distance. (Of course, this pushes interior holes inwards, making them smaller.) For instance, outsetting a rectangle by a distance d results in a rectangle each of whose edges has moved outwards by d, increasing its width and height by twice d. The most frequent use for Outset is to produce a border around a shape. To do this, copy the original shape, outset the copy, then subtract the original shape from the copy. To inset a shape (move the boundary inwards) call Outset with a negative distance. Inputs distance The distance (in the same coordinate system as the shape) by which to move the shape's outline. Outputs None. Exceptions Signalled kODErrOutOfMemory Not enough memory to complete the operation. The shape will be unmodified. Pre conditions None. Post conditions None. æKY ODShape::ReadShape Shape::ReadShape Shape->ReadShape æT Class Method æD ODShape* ReadShape( ODStorageUnit *su ); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Reads shape data from a storage unit into this shape. The storage unit must be pre-focused on a particular property. The kODPolygon value will be read if it exists, otherwise a platform-dependent shape value may be read if it exists, otherwise this object will be deleted and NULL will be returned. The proper usage of this call is: s = s->ReadShape(su); Inputs su Prefocused storage unit to read from. Outputs <return> The receiver if the data was read successfully; otherwise NULL. Exceptions Signalled None. Pre conditions Storage unit is prefocused to a property. Post conditions Shape is initialized [if data was found in su] otherwise this shape is deleted. æKY ODShape::Reset Shape::Reset Shape->Reset æT Class Method æD void Reset(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Clears the shape by making it empty, i.e. enclosing zero area. (You could also do this by calling SetRectangle with an empty rectangle, but Reset is easier to call and slightly more efficient.) Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODShape::SetGeometryMode Shape::SetGeometryMode Shape->SetGeometryMode æT Class Method æD void SetGeometryMode( ODGeometryMode mode ); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Sets the geometry mode (fMode) of this shape. See the discussion of the fMode field. Setting the mode to kODNeedsGeometry will throw a kODErrNoGeometry exception if the shape has no geometry. Inputs mode The geometry mode to use. Outputs None. Exceptions Signalled kODErrNoGeometry If mode is set to kODNeedsGeometry but shape has no geometry. Pre conditions None. Post conditions None. æKY ODShape::SetGXShape Shape::SetGXShape Shape->SetGXShape æT Class Method æD inline void SetGXShape ( gxShape shape ); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation This is a Mac-specific method that sets the shape to a QuickDraw GX shape passed in by the caller. The gxShape is consumed by the shape and the caller must not use or dispose it afterward. This call is identical to: this->SetPlatformShape(kODQuickDrawGX,(ODPlatformShape)shape); Inputs shape A reference to a QuickDraw GX shape of type polygon, path, empty or full. Outputs None. Exceptions Signalled None. Pre conditions QuickDraw GX is installed. Post conditions Shape owns the gx shape passed in. æKY ODShape::SetPlatformShape Shape::SetPlatformShape Shape->SetPlatformShape æT Class Method æD void SetPlatformShape( ODGraphicsSystem graphicsSystem, ODPlatformShape platformShape); æC Protection Public. No restrictions. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Sets the shape's graphics system dependent data. Whether or not the data is copied is also platform and graphics-system dependent. In the 1.0 Macintosh implementation, the data is not copied and the caller must not hang onto it after the call. Inputs graphicsSystem On Mac, kODQuickDraw or kODQuickDrawGX. platformShape On Mac, this is a RgnHandle or gxShape. Outputs None. Exceptions Signalled kODErrInvalidGraphicsSystem not a valid graphics system. Pre conditions graphicsSystem is a supported graphics system of the platform. platformShape is a valid platform-specific shape for this graphics system. Post conditions None. æKY ODShape::SetPolygon Shape::SetPolygon Shape->SetPolygon æT Class Method æD ODShape* SetPolygon( ODPolygon *polygon ); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Sets the shape based on the given polygon. The ODPolygon is not modified or used by the shape; the caller is still responsible for it afterward. Inputs polygon ODPolygon to use for this shape. Outputs <result> The receiver. Exceptions Signalled None. Pre conditions polygon points to a valid ODPolygon. Post conditions Shape is set to a copy of the given polygon. æKY ODShape::SetQDRegion Shape::SetQDRegion Shape->SetQDRegion æT Class Method æD inline void SetQDRegion ( RgnHandle rgn ); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation This is a Mac-specific method that sets the shape to a Region passed in by the caller. The region is consumed by the shape and the caller must not use or dispose it afterward. This call is identical to: this->SetPlatformShape(kODQuickDraw,(ODPlatformShape)rgn); Inputs rgn The QuickDraw region to set. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions Shape is equivalent to rgn. Shape either owns or has disposed the region passed in. æKY ODShape::SetRectangle Shape::SetRectangle Shape->SetRectangle æT Class Method æD ODShape* SetRectangle( ODRect *rect ); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Changes this shape to be a rectangle with the given coordinates. Inputs rect Rectangle to set this shape equal to. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions Shape is set to a rectangle identical to rect. æKY ODShape::somInit Shape::somInit Shape->somInit æT Class Method æD somInit(); æC Protection Public. Only factory methods should directly create shapes. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Creates an ODShape object with no shape data. This must be followed by a call to InitShape, SetRectangle, SetPlatformShape, CopyFrom or ReadShape (or ~ODShape, of course.) Inputs None. Outputs <return> an ODShape object. Exceptions Signalled None. Pre conditions None. Post conditions Shape is allocated but uninitialized (fShape==NULL.) æKY ODShape::somUninit Shape::somUninit Shape->somUninit æT Class Method æD somUninit(); æC Protection Public. Don't call directly; just delete the object. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Deletes an ODShape object and any private shape data. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions Shape, fShape (if any) and fShape's private data (if any) are deleted. æKY ODShape::Subtract Shape::Subtract Shape->Subtract æT Class Method æD ODShape* Subtract( ODShape* diffShape); æC Protection Public. No restrictions. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Substracts diffShape from this shape; result is stored in this shape. Inputs diffShape Shape to subtract from this shape. Outputs <result> The receiver. Exceptions Signalled kODErrOutOfMemory not enough memory to subtract shapes. kODErrNoShapeGeometry Geometry mode is kODNeedsGeometry, but diffShape has no geometry. Pre conditions None. Post conditions This shape is set to the value (this - diffShape). diffShape is unaltered. æKY ODShape::Transform Shape::Transform Shape->Transform æT Class Method æD ODShape* Transform( ODTransform* transform); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Runs this shape through a transformation (an offset, scale, rotation, skew, etc.) Inputs transform ODTransform to apply to this shape. Outputs <result> The receiver. Exceptions Signalled kODErrNoGeometry Shape doesn't have enough geometric information for this transformation. Pre conditions None. Post conditions Shape is transformed. æKY ODShape::Union Shape::Union Shape->Union æT Class Method æD ODShape* Union( ODShape* unionShape); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Unions this shape with sectShape. This shape becomes the union; unionShape is unchanged. Inputs unionShape Shape to combine with this shape. Outputs <result> The receiver. Exceptions Signalled kODErrNoGeometry Geometry mode is kODNeedsGeometry, but diffShape has no geometry. Pre conditions None. Post conditions This shape becomes the intersection of sectShape and its previous shape. sectShape is unchanged. æKY ODShape::WriteShape Shape::WriteShape Shape->WriteShape æT Class Method æD void WriteShape( ODStorageUnit *su ); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Writes shape data to a specific value of a storage unit. The storage unit must already be focused to a particular property. If possible the data will be written as a polygon, type kODPolygon. If the shape is not geometric, the data may be written in some platform dependent format (or an exception may be thrown.) Inputs su Storage unit (pre-focused) to write polygon data to. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions Shape data is written to one or more values of a property of the storage unit. æKY ODShape::fMode Shape::fMode æT Class Field æD ODGeometryMode fMode; // Private field This is the shape's geometry mode, which tells whether the shapes geometric info (its polygonal representation) will be needed in the future. It has three possible values: • kODPreserveGeometry --the default-- means that the shape will preserve its geometric information as long as possible until it is lost by combination with a non-geometric shape. • kODLoseGeometry means that the geometry is not needed and can be discarded to optimize speed. A facet's clipShape will generally have this mode. • kODNeedsGeometry means that the geometry is required. Rather than discard geometry, the shape will throw a kODErrNoShapeGeometry exception if combined with a non-geometric shape. A facet's frameShape and usedShape will have this mode since they are stored persistently in polygonal form. æC æKY ODShape::fShape Shape::fShape æT Class Field æD ODRealShape *fShape; // Private field This is the actual shape object. Most methods are delegated to this object. Some operations may change fShape into a different object of a different class: for instance, if fShape is an ODRectShape, and it is unioned with another rectangle, the result will usually not be a rectangle and fShape will be changed to a new ODPolygonShape or ODRgnShape. (This is all invisible to the client.) æC æKY ODShellPlugInHelp ODShellPlugIn ShellPlugIn æKL ODShellPlugIn::InitShellPlugIn ODShellPlugIn::Install æC Basic Class Documentation OpenDoc Shell PlugIn objects are a basic way to extend the OpenDoc Document Shell subsystem. Everytime a document is opened, the document shell initializes itself and the session for the document and then proceeds to run all the shell plugins which are installed on the machine. This way, ODShellPlugIn objects get a chance to add DispatchModules, FocusModules, entries to namespaces, and even patch the various session level objects such as ODClipboard. Superclass: ODExtension It is intended that Part Editor developers subclass this class. Theory of Operation Invariants Maintained by Class æKY ODShellPlugIn::InitShellPlugIn ShellPlugIn::InitShellPlugIn ShellPlugIn->InitShellPlugIn æT Class Method æD void InitShellPlugIn( ODPart* base); æC Protection Public. Override policy Derived class must override. Derived class must call base class behavior. Basic operation This method calls its superclasses' InitExtension method and initializes the shellplugin object. Inputs base The base object for this extension. Outputs None. Exceptions Signalled None. Pre conditions The shellplugin object is not initialized Post conditions The shellplugin object is initialized and is ready to execute other methods. æKY ODShellPlugIn::Install ShellPlugIn::Install ShellPlugIn->Install æT Class Method æD void Install( ODDraft* draft); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation This is an abstract method which must be implemented by a subclass of ODShellPlugIn. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions The shellplugin object has installed whatever functionality it needed to into this OpenDoc document session. æKY ODSIHelperHelp ODSIHelper SIHelper æKL ODSIHelper::Call… functions ODSIHelper::GetCoercionHandler ODSIHelper::GetEventHandler ODSIHelper::GetObjectAccessor ODSIHelper::GetSpecialHandler ODSIHelper::InitSIHelper ODSIHelper::InstallAdjustMarksProc ODSIHelper::InstallCoercionHandler ODSIHelper::InstallCompareProc ODSIHelper::InstallCountProc ODSIHelper::InstallDisposeTokenProc ODSIHelper::InstallEventHandler ODSIHelper::InstallGetErrDescProc ODSIHelper::InstallGetMarkTokenProc ODSIHelper::InstallMarkProc ODSIHelper::InstallObjectAccessor ODSIHelper::InstallSpecialHandler ODSIHelper::RemoveCoercionHandler ODSIHelper::RemoveEventHandler ODSIHelper::RemoveObjectAccessor ODSIHelper::RemoveSpecialHandler ODSIHelper::SIHelper ODSIHelper::~SIHelper ODSIHelper::fAdjustMarksProcPtr ODSIHelper::fCoercionHandlerTable ODSIHelper::fCompareProcPtr ODSIHelper::fCountProcPtr ODSIHelper::fDisposeTokenProcPtr ODSIHelper::fEventHandlerTable ODSIHelper::fGetErrDescProcPtr ODSIHelper::fMarkProcPtr ODSIHelper::fMarkTokenProcPtr ODSIHelper::fObjectAccessorTable æC Basic Class Documentation This class encapsulates the functionality necessary to install semantic event handlers and object accessors, as well as other special callbacks. These calls resemble their AppleEvent and AppleEvent object model counterparts very closely. An SIHelper object can be thought as a handler table. The platform vendor will implement if appropriate. The member functions of this class work similarly to the corresponding "AE<MemberFunctionName>" functions of the AppleEvent manager and the Object Support Library. SIHelper is a C++ class and is a subclass of SIHelperAbs. A minimum of documentation is given for functions that have counterparts in the AppleEvent Manager. Only differences are pointed out. The isSysHandler parameter is missing from all these routines. Instead, clients wishing to install system callback functions should call the appropriate Apple event Manager function. Only errors that are different from, or errors that occur in addition to the normal AppleEvent exceptions, are documented. Theory of Operation Each ODPart object that supports scripting and the ODSession can instantiate one or more of these for its own use. Additionally instances of SIHelper may be shared amongst instances of ODSemanticInterfaces. The owning object will install the necessary AppleEvent handlers and object accessor routines required to access its content model and to respond to the required AppleEvents. Callback functions have been changed to accomodate parts. All such functions take an ODPart* as a first parameter. This value will be kODAppShell for the system and document ODSemanticInterface objects. It will contain a pointer to the particular instance of ODPart (or a subclass) to which the ODSemanticInterface object belongs. Invariants Maintained by Class None. æKY ODSIHelper::Call… functions SIHelper::Call… functions SIHelper->Call… functions æT Class Method æD æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Note that all of the CallObjectAccessor, etc., calls from ODSemanticInterface are duplicated in this class as well. See the documentation for ODSemanticInterface. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODSIHelper::GetCoercionHandler SIHelper::GetCoercionHandler SIHelper->GetCoercionHandler æT Class Method æD virtual void GetCoercionHandler( DescType fromType, DescType toType, ODCoercionHandler* handler, ODSLong* handlerRefcon, ODBoolean* fromTypeIsDesc); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation See AppleEvent Manager documentation. Inputs toType The descriptor type of the resulting data. Outputs handler A pointer to the coercion handler. handlerRefCon A reference constant that is passed by the Apple Event Manager to the handler each time the handler is called. fromTypeIsDesc Specifies the form of the data to be coerced. If the value of this parameter is true, the coercion handler expects the data to be passed as a descriptor. If the value is false, the coercion handler expects a pointer to the data. Exceptions Signalled memFullErr Not enough room in heap zone errAEHandlerNotFound No coercion handler found Pre conditions None. Post conditions None. æKY ODSIHelper::GetEventHandler SIHelper::GetEventHandler SIHelper->GetEventHandler æT Class Method æD virtual void GetEventHandler( AEEventClass theAEEventClass, AEEventID theAEEventID, ODEventHandlerProcPtr* handler, ODSLong* handlerRefcon); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation See AppleEvent Manager documentation. Inputs theAEEventClass The event class for the Apple event or events to be dispatched for this entry. theAEEventID The event ID for the Apple event or events to be dispatched for this entry. Outputs handler A pointer to an Apple event handler for this dispatch table entry. handlerRefCon A reference constant that is passed by the Apple Event Manager to the handler each time the handler is called. Exceptions Signalled errAEHandlerNotFound No handler found for an Apple event Pre conditions None. Post conditions None. æKY ODSIHelper::GetObjectAccessor SIHelper::GetObjectAccessor SIHelper->GetObjectAccessor æT Class Method æD virtual void GetObjectAccessor( DescType desiredClass, DescType containerType, ODAccessorProcPtr* theAccessor, ODSLong* accessorRefcon); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation See AppleEvent Manager documentation. Inputs desiredClass The object class of the Apple event objects to be located by the object accessor function for this table entry. containerType The descriptor type of the token used to specify the container for the desired objects. Outputs theAccessor A pointer to the object accessor function for this table entry. accessorRefCon A reference constant passed by the Apple Event Manager to the object accessor function whenever the function is called. Exceptions Signalled See AppleEvent Mgr documentation. Pre conditions None. Post conditions None. æKY ODSIHelper::GetSpecialHandler SIHelper::GetSpecialHandler SIHelper->GetSpecialHandler æT Class Method æD virtual void GetSpecialHandler( AEKeyword functionClass, ODSpecialHandlerPtr* handler); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation See AppleEvent Manager documentation. Inputs functionClass The keyword for the special handler that is installed. Outputs handler A pointer to the special handler. Exceptions Signalled memFullErr Not enough room in heap zone errAENotASpecialFunction Wrong keyword for a special function Pre conditions None. Post conditions None. æKY ODSIHelper::InitSIHelper SIHelper::InitSIHelper SIHelper->InitSIHelper æT Class Method æD void InitSIHelper( ODSemanticInterface* face); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Initialize the object. Inputs face The ODSemanticInterface for which this will be a helper object. Outputs None Exceptions Signalled kODErrOutOfMemory Not enough room to allocate internal structures. Pre conditions None. Post conditions fEventHandlerTable, fObjectAccessorTable, and fCoercionHandlerTable, et al have been succesfully instantiated. æKY ODSIHelper::InstallAdjustMarksProc SIHelper::InstallAdjustMarksProc SIHelper->InstallAdjustMarksProc æT Class Method æD InstallAdjustMarksProc( ODMarkPtr adjustMarksProc, ODSLong refCon); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Install a reference to a callback function that gets called to unmark objects that have previously been marked. Inputs countProc the procedure pointer refCon a reference constant Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions The callback function and refCon are stored and available for future use by the Semantic Events subsystem. æKY ODSIHelper::InstallCoercionHandler SIHelper::InstallCoercionHandler SIHelper->InstallCoercionHandler æT Class Method æD virtual void InstallCoercionHandler( DescType fromType, DescType toType, ODCoercionHandler handler, ODSLong handlerRefcon, ODBoolean fromTypeIsDesc); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation See AppleEvent Manager documentation. Inputs fromType The descriptor type of the data coerced by the handler. toType The descriptor type of the resulting data. handler A pointer to the coercion handler. handlerRefcon A reference constant that is passed by the Apple Event Manager to the handler each time the handler is called. fromTypeIsDesc Specifies the form of the data to be coerced. If the value of this parameter is true, the coercion handler expects the data to be passed as a descriptor. If the value is false, the coercion handler expects a pointer to the data. Outputs None. Exceptions Signalled memFullErr Not enough room in heap zone Pre conditions None. Post conditions The function will be installed in the coercion handler table. æKY ODSIHelper::InstallCompareProc SIHelper::InstallCompareProc SIHelper->InstallCompareProc æT Class Method æD InstallCompareProc( ODCompareProcPtr compareProc, ODSLong refCon); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Install a reference to a callback function that compares objects. Inputs compareProc the procedure pointer refCon a reference constant Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions The callback function and refCon are stored and available for future use by the Semantic Events subsystem. æKY ODSIHelper::InstallCountProc SIHelper::InstallCountProc SIHelper->InstallCountProc æT Class Method æD InstallCountProc( ODCountProcPtr countProc, ODSLong refCon); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Install a reference to a callback function that counts objects. Inputs countProc the procedure pointer refCon a reference constant Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions The callback function and refCon are stored and available for future use by the Semantic Events subsystem. æKY ODSIHelper::InstallDisposeTokenProc SIHelper::InstallDisposeTokenProc SIHelper->InstallDisposeTokenProc æT Class Method æD InstallDisposeTokenProc( ODDisposeTokenProcPtr disposeTokenProc, ODSLong refCon); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Install a reference to a callback function that disposes tokens. Inputs countProc the procedure pointer refCon a reference constant Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions The callback function and refCon are stored and available for future use by the Semantic Events subsystem. æKY ODSIHelper::InstallEventHandler SIHelper::InstallEventHandler SIHelper->InstallEventHandler æT Class Method æD virtual void InstallEventHandler( AEEventClass theAEEventClass, AEEventID theAEEventID, ODEventHandlerProcPtr handler, ODSLong handlerRefcon, ODUlong mode); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation See AppleEvent Manager documentation. Inputs theAEEventClass The event class for the Apple event or events to be dispatched for this entry. theAEEventID The event ID for the Apple event or events to be dispatched for this entry. handler A pointer to an Apple event handler for this dispatch table entry. handlerRefCon A reference constant that is passed by the Apple Event Manager to the handler each time the handler is called. mode mode flags. If kODAlwaysForward is specified, any event received by the document is always forwarded to this handler. Outputs None. Exceptions Signalled memFullErr Not enough room in heap zone Pre conditions None. Post conditions The function will be installed in the event handler table. æKY ODSIHelper::InstallGetErrDescProc SIHelper::InstallGetErrDescProc SIHelper->InstallGetErrDescProc æT Class Method æD InstallGetErrDescProc( ODMarkPtr getErrDescProc, ODSLong refCon); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Install a reference to a callback function that gets called to return a pointer to a client's descriptor record that will be used to write the descriptor for the last object being worked on when an error occurred. Inputs countProc the procedure pointer refCon a reference constant Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions The callback function and refCon are stored and available for future use by the Semantic Events subsystem. æKY ODSIHelper::InstallGetMarkTokenProc SIHelper::InstallGetMarkTokenProc SIHelper->InstallGetMarkTokenProc æT Class Method æD InstallGetMarkTokenProc( ODGetMarkTokenProcPtr getMarkTokenProc, ODSLong refCon); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Install a reference to a callback function that gets a token that the client will use to mark set of objects. Inputs countProc the procedure pointer refCon a reference constant Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions The callback function and refCon are stored and available for future use by the Semantic Events subsystem. æKY ODSIHelper::InstallMarkProc SIHelper::InstallMarkProc SIHelper->InstallMarkProc æT Class Method æD InstallMarkProc( ODMarkPtr markProc, ODSLong refCon); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Install a reference to a callback function that gets called repeatedly to mark a set of objects. Inputs countProc the procedure pointer refCon a reference constant Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions The callback function and refCon are stored and available for future use by the Semantic Events subsystem. æKY ODSIHelper::InstallObjectAccessor SIHelper::InstallObjectAccessor SIHelper->InstallObjectAccessor æT Class Method æD virtual void InstallObjectAccessor( DescType desiredClass, DescType containerType, ODAccessorProcPtr theAccessor, ODSLong accessorRefcon); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation See AppleEvent Manager documentation. Inputs desiredClass The object class of the Apple event objects to be located by the object accessor function for this table entry. containerType The descriptor type of the token used to specify the container for the desired objects. theAccessor A pointer to the object accessor function for this table entry. accessorRefCon A reference constant passed by the Apple Event Manager to the object accessor function whenever the function is called. Outputs None Exceptions Signalled See AppleEvent Manager documentation See AppleEvent Manager documentation kODErrOutOfMemory out of memory Pre conditions None. Post conditions The function will be installed in the object acessor table. An existing function will be replaced. æKY ODSIHelper::InstallSpecialHandler SIHelper::InstallSpecialHandler SIHelper->InstallSpecialHandler æT Class Method æD virtual void InstallSpecialHandler( AEKeyword functionClass, ODSpecialHandlerPtr handler); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation See AppleEvent Manager documentation. Inputs functionClass The keyword for the special handler that is installed. handler A pointer to the special handler. Outputs None. Exceptions Signalled paramErr handler pointer is nil or odd memFullErr Not enough room in heap zone errAENotASpecialFunction Wrong keyword for a special function Pre conditions None. Post conditions The function will be installed in the special handler table. æKY ODSIHelper::RemoveCoercionHandler SIHelper::RemoveCoercionHandler SIHelper->RemoveCoercionHandler æT Class Method æD virtual void RemoveCoercionHandler( DescType fromType, DescType toType, ODCoercionHandler handler); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation See AppleEvent Manager documentation. Inputs fromType The descriptor type of the data coerced by the handler. toType The descriptor type of the resulting data. handler A pointer to the coercion handler. Outputs None. Exceptions Signalled memFullErr Not enough room in heap zone errAEHandlerNotFound No coercion handler found Pre conditions None. Post conditions The function is removed from the coercion handler table. æKY ODSIHelper::RemoveEventHandler SIHelper::RemoveEventHandler SIHelper->RemoveEventHandler æT Class Method æD virtual void RemoveEventHandler( AEEventClass theAEEventClass, AEEventID theAEEventID, ODEventHandlerProcPtr handler); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation See AppleEvent Manager documentation. Inputs theAEEventClass The event class for the Apple event or events to be dispatched for this entry. theAEEventID The event ID for the Apple event or events to be dispatched for this entry. handler A pointer to an Apple event handler for this dispatch table entry. Outputs None. Exceptions Signalled errAEHandlerNotFound No handler found for an Apple event Pre conditions None. Post conditions The function is removed from the event handler table. æKY ODSIHelper::RemoveObjectAccessor SIHelper::RemoveObjectAccessor SIHelper->RemoveObjectAccessor æT Class Method æD virtual void RemoveObjectAccessor( DescType desiredClass, DescType containerType, ODAccessorProcPtr theAccessor); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation See AppleEvent Manager documentation. Inputs desiredClass The object class of the Apple event objects located by the object accessor function. containerType The descriptor type of the token that identifies the container for the objects located by the object accessor function. theAccessor A pointer to the object accessor function you want to remove. Outputs None. Exceptions Signalled See AppleEvent Mgr documentation. Pre conditions None. Post conditions The object accessor function is removed from the object accessor table. æKY ODSIHelper::RemoveSpecialHandler SIHelper::RemoveSpecialHandler SIHelper->RemoveSpecialHandler æT Class Method æD virtual void RemoveSpecialHandler( AEKeyword functionClass, ODSpecialHandlerPtr handler); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation See AppleEvent Manager documentation. Inputs functionClass The keyword for the special handler that is installed. handler A pointer to the special handler. Outputs None. Exceptions Signalled memFullErr Not enough room in heap zone errAENotASpecialFunction Wrong keyword for a special function Pre conditions None. Post conditions The function is removed from the special handler table. æKY ODSIHelper::SIHelper SIHelper::SIHelper SIHelper->SIHelper æT Class Method æD SIHelper(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Initialize the fields object. Inputs None. Outputs None Exceptions Signalled None. Pre conditions None. Post conditions Object is instantiated. æKY ODSIHelper::~SIHelper SIHelper::~SIHelper SIHelper->~SIHelper æT Class Method æD ~SIHelper(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Destroy the object Inputs None Outputs None Exceptions Signalled None. Pre conditions None. Post conditions Object is destroyed. æKY ODSIHelper::fAdjustMarksProcPtr SIHelper::fAdjustMarksProcPtr æT Class Field æD ODAdjustMarksProcPtr fAdjustMarksProcPtr æC Persistent form None. æKY ODSIHelper::fCoercionHandlerTable SIHelper::fCoercionHandlerTable æT Class Field æD ODHashTable* fCoercionHandlerTable; æC Persistent form None. æKY ODSIHelper::fCompareProcPtr SIHelper::fCompareProcPtr æT Class Field æD ODCompareProcPtr fCompareProcPtr æC Persistent form None. æKY ODSIHelper::fCountProcPtr SIHelper::fCountProcPtr æT Class Field æD ODCountProcPtr fCountProcPtr æC Persistent form None. æKY ODSIHelper::fDisposeTokenProcPtr SIHelper::fDisposeTokenProcPtr æT Class Field æD ODDisposeToeknProcPtr fDisposeTokenProcPtr æC Persistent form None. æKY ODSIHelper::fEventHandlerTable SIHelper::fEventHandlerTable æT Class Field æD ODHashTable* fEventHandlerTable; æC Persistent form None. æKY ODSIHelper::fGetErrDescProcPtr SIHelper::fGetErrDescProcPtr æT Class Field æD ODErrDescProcPtr fGetErrDescProcPtr æC Persistent form None. æKY ODSIHelper::fMarkProcPtr SIHelper::fMarkProcPtr æT Class Field æD ODMarkProcPtr fMarkProcPtr æC Persistent form None. æKY ODSIHelper::fMarkTokenProcPtr SIHelper::fMarkTokenProcPtr æT Class Field æD ODGetMarkTokenProcPtr fMarkTokenProcPtr æC Persistent form None. æKY ODSIHelper::fObjectAccessorTable SIHelper::fObjectAccessorTable æT Class Field æD ODHashTable* fObjectAccessorTable; æC æKY ODSIHelperAbsHelp ODSIHelperAbs SIHelperAbs æKL ODSIHelperAbs::Call… functions ODSIHelperAbs::SIHelper ODSIHelperAbs::~SIHelper æC Basic Class Documentation This class encapsulates the interface necessary to install semantic event handlers and object accessors, as well as other special callbacks. These calls resemble their AppleEvent and AppleEvent object model counterparts very closely. Every ODCPlusSemanticInterface instance must own a subclass of SIHelperAbs. The platform vendor will implement if appropriate. The member functions of this class should work similarly to the corresponding "AE<MemberFunctionName>" functions of the AppleEvent manager and the Object Support Library. SIHelperAbs is a abstract C++ class and must be subclassed. A minimum of documentation is given for functions that have counterparts in the AppleEvent Manager. Only differences are pointed out. The isSysHandler parameter is missing from all these routines. Instead, clients wishing to install system callback functions should call the appropriate Apple event Manager function. Only errors that are different from, or errors that occur in addition to the normal AppleEvent exceptions, are documented. Theory of Operation Each ODPart object that supports scripting can instantiate one or more of these for its own use. Additionally instances of SIHelperAbs subclasses may be shared amongst instances of ODCPlusSemanticInterfaces. The owning object will install the necessary AppleEvent handlers and object accessor routines required to access its content model and to respond to the required AppleEvents. Callback functions have been changed to accomodate parts. All such functions take an ODPart* as a first parameter. This value will be kODAppShell for the system and document ODSemanticInterface objects. It will contain a pointer to the particular instance of ODPart (or a subclass) to which the ODSemanticInterface object belongs. Invariants Maintained by Class None. æKY ODSIHelperAbs::Call… functions SIHelperAbs::Call… functions SIHelperAbs->Call… functions æT Class Method æD æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Note that all of the CallObjectAccessor, etc., calls from ODSemanticInterface are duplicated in this class as well. See the documentation for ODSemanticInterface. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODSIHelperAbs::SIHelper SIHelperAbs::SIHelper SIHelperAbs->SIHelper æT Class Method æD SIHelper(); æC Protection Public. Only parts should create SIHelper. The application shell should obtain its copy of an ODSemanticInterface throughthe ODSession. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Initialize the fields object. Inputs None. Outputs None Exceptions Signalled None. Pre conditions None. Post conditions Object is instantiated. æKY ODSIHelperAbs::~SIHelper SIHelperAbs::~SIHelper SIHelperAbs->~SIHelper æT Class Method æD ~SIHelper(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Destroy the object Inputs None Outputs None Exceptions Signalled None. Pre conditions None. Post conditions Object is destroyed. æKY ODStorageSystemHelp ODStorageSystem StorageSystem æKL ODStorageSystem::CreateContainer ODStorageSystem::CreatePlatformTypeList ODStorageSystem::CreateTypeList ODStorageSystem::GetContainer ODStorageSystem::GetSession ODStorageSystem::GrowHeap ODStorageSystem::InitStorageSystem ODStorageSystem::NeedSpace ODStorageSystem::ODAbsStorageSystem ODStorageSystem::Purge ODStorageSystem::ReleaseContainer ODStorageSystem::~ODAbsStorageSystem ODStorageSystem::fContainers ODStorageSystem::fHeap ODStorageSystem::fSession æC Basic Class Documentation When a OpenDoc session is launched, it creates a bunch of objects which are global for that session, one of these is an ODStorageSystem object.When the OpenDoc session ends, this ODStorageSystem object is deleted. The class documented here (ODAbsStorageSystem) is the abstract base class for any ODStorageSystem. Platform Implementors should subclass ODAbsStorageSystem to provide the functionality of the OpenDoc Storage System on their platforms. Theory of Operation This class is instantiated only by ODSession. There is only one ODStorageSystem object per session. The ODStorageSystem object is purely an in-memory object, and has no persistent state. Containers are created and retrieved by calling CreateContainer and GetContainer of the ODStorageSystem object. The ODContainer objects in turn provide access to Documents, which provide access to Drafts which provide access to Storage Units. The ODStorageSystem object is responsible for guaranteeing that there is only one ODContainer object associated with each physical Container. Each Container is responsible for guaranteeing that there is only one ODDocument object associated with each Document within it. Each Document is responsible for guaranteeing that there is only one ODDraft objectassociated with each Draft within it. Each Draft in turn is responsible for guaranteeing that there is only oneODStorageUnit objectassociated with each StorageUnit, Part, Frame, LinkSource and Link within it. Invariants Maintained by Class There is at most one ODContainer object for every ODContainerType, ODContainerID tuple requested via GetContainer or CreateContainer. Until a requested Container has been Released, the ODContainer object will be valid. After a requested Container has been Released, the ODContainer object which referred to that Container is not valid. It is the responsibility of ODStorageSystem to maintain these invariants, not ODContainer, since ODStorageSystem maintains the collection of ODContainers. æKY ODStorageSystem::CreateContainer StorageSystem::CreateContainer StorageSystem->CreateContainer æT Class Method æD ODContainer* CreateContainer( ODContainerType containerType, ODContainerID id); æC Protection Public. Called by Shell or Container App to create a new OpenDoc Container. Override policy Derived class must override. Derived class cannot call base class behavior, before derived class behavior. Basic operation Create a new container which corresponds to the given containerType and id. See GetContainer() for more information on id and containerType. Inputs id a pointer to a container brand specific structure in memory containerType a general type of container Outputs <return> A fully functional ODContainer object which refers to the Container of the given containType and id. Exceptions Signalled kODInvalidContainerID Invalid Container ID. kODCannotCreateContainer Invalid Container Type. Pre conditions None. Post conditions None. æKY ODStorageSystem::CreatePlatformTypeList StorageSystem::CreatePlatformTypeList StorageSystem->CreatePlatformTypeList æT Class Method æD ODPlatformTypeList CreatePlatformTypeList( in ODPlatformTypeList typeList); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, before derived class behavior. Basic operation This function creates an empty ODPlatformTypeList if typeList is kODNULL. If typeList is not kODNULL, this function will return a copy of the typeList. Inputs typeList platformTypeList to be duplicated Outputs <return> PlatformTypeList Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODStorageSystem::CreateTypeList StorageSystem::CreateTypeList StorageSystem->CreateTypeList æT Class Method æD ODTypeList CreateTypeList( in ODTypeList typeList); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, before derived class behavior. Basic operation This function creates an empty ODTypeList if typeList is kODNULL. If typeList is not kODNULL, this function will return a copy of the typeList. Inputs typeList type list to be duplicated (if not kODNULL). Outputs <return> Type List Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODStorageSystem::GetContainer StorageSystem::GetContainer StorageSystem->GetContainer æT Class Method æD ODContainer* GetContainer( ODContainerType containerType, ODContainerID id); æC Protection Public. Called by the Shell or Container App when it needs to open an OpenDoc document. Override policy Derived class must override. Derived class cannot call base class behavior, before derived class behavior. Basic operation Returns a ODContainer object which refers to the container of the specified containerType and with the specified id. ODContainerID is a 32-bit value and is only used by the ODContainer object. Therefore, its format is completely opaque to the Storage System. Typically, it is a pointer to a container brand specific structure in memory (e.g., FileSpec). Inputs id ID of the desired Container. containerType Type of the desired Container. Outputs <return> A fully functional ODContainer object which refers to the Container of the given containType and id. Exceptions Signalled kODInvalidContainerID Invalid Container ID. kODCannotGetContainer Invalid Container Type. Pre conditions None. Post conditions None. æKY ODStorageSystem::GetSession StorageSystem::GetSession StorageSystem->GetSession æT Class Method æD ODSession* GetSession(); æC Protection Public. Parts can call this method even though they should really be calling ODStorageUnit::GetSession(). Override policy Derived class must override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns the current ODSession object. Inputs none Outputs <return> ODBaseSession in which this ODStorageSystem runs. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODStorageSystem::GrowHeap StorageSystem::GrowHeap StorageSystem->GrowHeap æT Class Method æD void GrowHeap( ODSize memSize); æC Protection Protected. This is only called by ODAbsStorageSystem::NeedSpace. Override policy Derived class must override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Grows the heap by memSize. This call does not guarantee to grow the heap by the requested size. Inputs memSize Number of bytes by which the heap should grow. Outputs none Exceptions Signalled None. Pre conditions None. Post conditions The heap has grown by memSize, or to the biggest size it can be, whichever is smaller. æKY ODStorageSystem::InitStorageSystem StorageSystem::InitStorageSystem StorageSystem->InitStorageSystem æT Class Method æD void InitStorageSystem(); æC Protection Public. Private between ODSession and ODStorageSystem. This method should only be called by ODSession::InitSession. Override policy Derived class must override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Initializes this ODStorageSystem object. Inputs none Outputs none Exceptions Signalled None. Pre conditions this is a valid ODStorageSystem object. Post conditions this is an initialized ODStorageSystem object. æKY ODStorageSystem::NeedSpace StorageSystem::NeedSpace StorageSystem->NeedSpace æT Class Method æD void NeedSpace( ODSize memSize, ODBoolean doPurge); æC Protection Public. This method can be called by any class. However, it should be used cautiously as this may be a slow operation. Override policy Derived class must override. Derived class cannot call base class behavior, during derived class behavior. Basic operation This is called to check for or preflight some memory, i.e. This should be called when an object anticipates the usage of a large memory block. It can also be used as a maintainence call for cleaning up the heap. doPurge indicates whether or not this object should try to purge memory. This is done by calling Purge on its ODContainers and transitively their ODDocuments, ODDrafts and persistent objects and ODStorageUnits . This call is not guaranteed to generate the memory requested. Inputs memSize size of memory block desired doPurge whether or not to purge if necessary Outputs none Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODStorageSystem::ODAbsStorageSystem StorageSystem::ODAbsStorageSystem StorageSystem->ODAbsStorageSystem æT Class Method æD ODAbsStorageSystem( ODBaseSession* session, ODHeap heap); æC Protection Public. This method is only called by ODSession::InitSession. Override policy Derived class must override. Derived class must call base class behavior, before derived class behavior. Basic operation This method is the constructor of the class. Inputs session the ODSession object for this OpenDoc session heap the heap for this session Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODStorageSystem::Purge StorageSystem::Purge StorageSystem->Purge æT Class Method æD ODSize Purge( ODSize size); æC Protection Protected. This is only called by ODAbsStorageSystem::NeedSpace. Override policy Derived class must override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Purge memory from ephemeral store until size bytes (not necessarily contiguous) have been freed up. Inputs size Desired number of bytes to purge. Outputs <return> Number of bytes actually purged Exceptions Signalled None. Pre conditions None. Post conditions There are at least size bytes (not necessarily contiguous) free in the heap or Purge() has been called on every ODContainer in this ODStorageSystem. æKY ODStorageSystem::ReleaseContainer StorageSystem::ReleaseContainer StorageSystem->ReleaseContainer æT Class Method æD ODStorageSystem* ReleaseContainer( ODContainer* container); æC Protection Public. Private between ODStorageSystem and ODContainer. This method should only be called by ODContainer::Release. Override policy Derived class must override. Derived class cannot call base class behavior, before derived class behavior. Basic operation Releases the specified ODContainer object. Inputs container the container to be released Outputs <return> this Exceptions Signalled None. Pre conditions container is a valid ODContainer object which was obtained via either GetContainer or CreateContainer. Post conditions container is no longer a valid ODContainer object. æKY ODStorageSystem::~ODAbsStorageSystem StorageSystem::~ODAbsStorageSystem StorageSystem->~ODAbsStorageSystem æT Class Method æD ~ODAbsStorageSystem(); æC Protection Public. Private between ODSession and ODStorageSystem. This method is only called by ODSession::~ODSession. Override policy Derived class must override. Derived class must call base class behavior, after derived class behavior. Basic operation This is the destructor of the class. Inputs none Outputs none Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODStorageSystem::fContainers StorageSystem::fContainers æT Class Field æD LinkedList* æC Persistent form None. æKY ODStorageSystem::fHeap StorageSystem::fHeap æT Class Field æD ODHeap æC Persistent form None. æKY ODStorageSystem::fSession StorageSystem::fSession æT Class Field æD ODSession* æC æKY ODStorageUnitHelp ODStorageUnit StorageUnit æKL ODStorageUnit::ODStorageUnit ODStorageUnit::~ODStorageUnit ODStorageUnit::AddProperty ODStorageUnit::AddValue ODStorageUnit::ClearAllPromises ODStorageUnit::CloneInto ODStorageUnit::CopyTo ODStorageUnit::CountProperties ODStorageUnit::CountValues ODStorageUnit::CreateCursor ODStorageUnit::CreateCursorWithFocus ODStorageUnit::CreateStorageUnitRefIterator ODStorageUnit::CreateView ODStorageUnit::DeleteValue ODStorageUnit::Exists ODStorageUnit::ExistsWithCursor ODStorageUnit::Externalize ODStorageUnit::Focus ODStorageUnit::Focus ODStorageUnit::GetDraft ODStorageUnit::GetGenerationNumber ODStorageUnit::GetID ODStorageUnit::GetIDFromStorageUnitRef ODStorageUnit::GetName ODStorageUnit::GetOffset ODStorageUnit::GetPromiseValue ODStorageUnit::GetProperty ODStorageUnit::GetSession ODStorageUnit::GetSize ODStorageUnit::GetStorageUnitRefIterator ODStorageUnit::GetStrongStorageUnitRef ODStorageUnit::GetType ODStorageUnit::GetValue ODStorageUnit::GetWeakStorageUnitRef ODStorageUnit::IncrementGenerationNumber ODStorageUnit::IncrementRefCount ODStorageUnit::InitStorageUnit ODStorageUnit::InsertValue ODStorageUnit::Internalize ODStorageUnit::IsPromiseValue ODStorageUnit::IsStrongStorageUnitRef ODStorageUnit::IsValidStorageUnitRef ODStorageUnit::IsWeakStorageUnitRef ODStorageUnit::Lock ODStorageUnit::Purge ODStorageUnit::Release ODStorageUnit::Remove ODStorageUnit::RemoveStorageUnitRef ODStorageUnit::ResolveAllPromises ODStorageUnit::SetName ODStorageUnit::SetOffset ODStorageUnit::SetPromiseValue ODStorageUnit::SetType ODStorageUnit::SetValue ODStorageUnit::Unlock ODStorageUnit::fCurProperty ODStorageUnit::fCurValueIndex ODStorageUnit::fCurValueType ODStorageUnit::fDoesAutoResolve ODStorageUnit::fDraft ODStorageUnit::fHasPropertyLooped ODStorageUnit::fHasValueLooped ODStorageUnit::fID æC Basic Class Documentation A StorageUnit is the basic unit of persistent storage. It contains a list of properties, each of which has a unique name within the Storage Unit, and an ordered list of Values. ODStorageUnit is used to manipulate a Storage Unit. To keep clean and minimize the api, a set of common functions which can apply to the entire StorageUnit, a particular property, or a particular value have been abstracted out. The class documented here is a abstract base class. Container Suite implementors should subclass this class to provide the functionality of a OpenDoc Storage Unit for their Container Suite. (For definition of Container Suite, please refer to documentation on ODContainer). Note: ODStorageUnitView is almost identical to ODStorageUnit, except that it has a fixed focus which is set upon creation of the ODStorageUnitView object. ODStorageUnit is only instantiated by ODDraft of the same Container Suite. When a Part or the Container App needs a Storage Unit, it will call ODDraft::CreateStorage or ODDraft::GetStorageUnit. Theory of Operation Properties and Values within a StorageUnit are not represented by objects. To indicate the context for calls which assume the context of the entire StorageUnit, a particular property, or a particular value, one uses the Focus method. Focusing can be absolute by passing a particular property name or value index, or relative by passing in positioncodes. When focussed to a particular value, the StorageUnit provides a stream interface to that value. This class is derived from ODRefCntObject. A ODStorageUnit object is instantiated when CreateStorageUnit or GetStorageUnit is called on its corresponding ODDraft. When ODStorageUnit is first constructed, its refCount is 1. Every time ODDraft::GetStorageUnit is called on the same Storage Unit, the refCount of the ODDraft object is incremented by 1. When ODStorageUnit object is no longer needed, ODStorageUnit::Release should be called. The ODDraft object is responsible for guaranteeing that there is only one ODStorageUnit object associated with each Storage Unit or persistent object within it. A Property/Value combination is usually referred to as a context. When a context is applied to a ODStorageUnit, this context is specifically called a focus. Many ODStorageUnit operations require the establishment of a focus. If a ODStorageUnit is focused to a Value, the ODStorageUnit also has a current offset. When the ODStorageUnit is refocused (either to the same Value or to another Value), the current offset is reset to 0. Storage Units can maintain persistent references to each other. These references are created and resolved using special ODStorageUnit methods. Invariants Maintained by Class The focus of a StorageUnit is conserved over all methods except Focus, Remove and Add(Property/Value), which changes the focus to the (Property/Value) which was just added. æKY ODStorageUnit::ODStorageUnit StorageUnit::ODStorageUnit StorageUnit->ODStorageUnit æT Class Method æD ODStorageUnit(); æC Protection Public. Private within Container Suite. This method should only be called by ODDraft::CreateStorageUnit or ODDraft::GetStorageUnit. Override policy Derived class must override. Derived class must call base class behavior. Basic operation This method is the constructor of the class. Inputs None. Outputs <return> this Exceptions Signalled None. Pre conditions None. Post conditions The return result is an uninitialized ODStorageUnit object. æKY ODStorageUnit::~ODStorageUnit StorageUnit::~ODStorageUnit StorageUnit->~ODStorageUnit æT Class Method æD ~ODStorageUnit(); æC Protection Public. Private within Container Suite. This method should only be called by ODDraft. Override policy Derived class must override. Derived class must call base class behavior. Basic operation This method is the destructor of the class. Note that it does not externalize the ODStorageUnit object. Inputs none Outputs none Exceptions Signalled None. Pre conditions None. Post conditions this is no longer a valid ODStorageUnit object. æKY ODStorageUnit::AddProperty StorageUnit::AddProperty StorageUnit->AddProperty æT Class Method æD ODStorageUnit* AddProperty( ODPropertyName propertyName); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation If no property with the same name exist in this storage unit, it is added. The focus is set to the given property. Inputs propertyName Name of the property to add Outputs <return> this Exceptions Signalled kODErrInvalidPropertyName propertyName is kODNULL kODErrCannotAddProperty Failure to add the given Property. Pre conditions A Property with the given name may or may not exist in the Storage Unit. Post conditions ODStorageUnit is focused to the Property of the given name. æKY ODStorageUnit::AddValue StorageUnit::AddValue StorageUnit->AddValue æT Class Method æD ODStorageUnit* AddValue( ODValueType type); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation If a Value with the given type does not exist in the property currently focused to, a Value with the given type is added. The focus is set to the Value of the given type. Inputs type type of value to add Outputs <return> this Exceptions Signalled kODErrValueExists Value exists alreday. kODErrUnfocusedStorageUnit This ODStorageUnit is not focused to a Property. kODErrInvalidType type is kODNULL. kODErrCannotAddType Cannot add Type to Storage Unit. Pre conditions this ODStorageUnit must be focused to a Property. The given type may or may not exist in the focused Proeprty. Post conditions ODStorageUnit is focused to the Value with the given type. æKY ODStorageUnit::ClearAllPromises StorageUnit::ClearAllPromises StorageUnit->ClearAllPromises æT Class Method æD void ClearAllPromises(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Removes all Values containing promises from this Storage Unit. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODStorageUnit::CloneInto StorageUnit::CloneInto StorageUnit->CloneInto æT Class Method æD void CloneInto( ODDraftKey key, ODStorageUnit* destStorageUnit, ODID scopeID); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Deep-copy all Properties and Values of this Storage Unit to the specified destStorageUnit. In order to avoid copying extra Storage Units during the deep-copy, an scopeID may be specified. If scopeID is not 0, only those Storage Units reachable from the object or storage unit with scopeID will be copied. If initiatingFrameSU is 0, all the Storage Units reachable from this Object or Storage Unit will be copied. Note that the actual copying may not be completed until after EndClone is finished. Inputs key ODDraftKey identifying the Clone transaction. destStorageUnit Destination Storage Unit scopeID All Storage Units cloned from this point on should be within the scope of this object or storage unit. Outputs none Exceptions Signalled kODErrCloneNotStarted A Clone was started unsuccessfully. kODErrInvalidDraftKey Invalid Clone. Pre conditions None. Post conditions None. æKY ODStorageUnit::CopyTo StorageUnit::CopyTo StorageUnit->CopyTo æT Class Method æD void CopyTo( ODStorageUnit* toSU); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Shallow Copy (i.e., one-level) properties and values of this storageUnit to the given toSU. Inputs toSU the storage unit from which data is to be copied Outputs none Exceptions Signalled None. Pre conditions None. Post conditions All properties and values in this ODStorageUnit have their respective values in toSU. æKY ODStorageUnit::CountProperties StorageUnit::CountProperties StorageUnit->CountProperties æT Class Method æD ODULong CountProperties(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns the number of Properties in this ODStorageUnit. Inputs None Outputs <return> Number or Properties in this ODStorageUnit. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODStorageUnit::CountValues StorageUnit::CountValues StorageUnit->CountValues æT Class Method æD ODULong CountValues(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns the number of Values in this focused ODStorageUnit. Inputs None Outputs <return> Number or Values in this focused ODStorageUnit. Exceptions Signalled kODErrUnfocusedStorageUnit This ODStorageUnit is not focused to a Property. Pre conditions This ODStorageUnit must be focused to a Property or a Value. Post conditions None. æKY ODStorageUnit::CreateCursor StorageUnit::CreateCursor StorageUnit->CreateCursor æT Class Method æD ODStorageUnitCursor CreateCursor( in ODPropertyName propertyName, in ODValueType valueType, in ODValueIndex valueIndex); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation This method creates a ODStorageUnitCursor according to the input parameters. Inputs propertyName propertyName valueType valueType valueIndex valueIndex Outputs <return> ODStorageUnitCursor. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODStorageUnit::CreateCursorWithFocus StorageUnit::CreateCursorWithFocus StorageUnit->CreateCursorWithFocus æT Class Method æD ODStorageUnitCursor* CreateCursorWithFocus(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Creates a ODCursor object from the current focus of this ODStorageUnit and returns it. Inputs none Outputs <return> a newly created storageUnitCursor Exceptions Signalled kODErrUnfocusedStorageUnit This ODStorageUnit is not focused to a Property or a Value. Pre conditions None. Post conditions The returned ODStorageUnitCursor object contains the same context as this ODStorageUnit object. æKY ODStorageUnit::CreateStorageUnitRefIterator StorageUnit::CreateStorageUnitRefIterator StorageUnit->CreateStorageUnitRefIterator æT Class Method æD ODStorageUnitRefIterator* CreateStorageUnitRefIterator(); æC Protection Public. Override policy Derived class must override. Derived class must call base class behavior. Basic operation This function creates a ODStorageUnitRefIterator for the focused value. The returned ODStorageUnitRefIterator can be used to iterate through all the ODStorageUnitRef in the value. Inputs None. Outputs <return> ODStorageUnitRefIterator for the focused value. Exceptions Signalled None. Pre conditions The storage unit must be focused to a value. Post conditions None. æKY ODStorageUnit::CreateView StorageUnit::CreateView StorageUnit->CreateView æT Class Method æD ODStorageUnitView* CreateView(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation This method uses this ODStorageUnit and the focus of this ODStorageUnit to create a new ODStorageUnitView object. The new ODStorageUnitView object is returned as the function result. Inputs None. Outputs <return> a StorageUnitView of this unit and the given curosr or the focus of this unit Exceptions Signalled None. Pre conditions None. Post conditions The returned ODStorageUnitView represents the appropriate context of this ODStorageUnit. æKY ODStorageUnit::DeleteValue StorageUnit::DeleteValue StorageUnit->DeleteValue æT Class Method æD void DeleteValue( ODULong length); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Deletes length bytes at the current offset in the current value focus. If the focused Value is a Promise Value, the Promise is resolved first before insertion is done. Inputs length the length of bytes to delete from the focussed value Outputs none Exceptions Signalled kODErrUnfocusedStorageUnit This ODStorageUnit is not focused to a Value. Pre conditions this ODStorageUnit object is focused to a particular value. Post conditions length bytes at the current offset in the current value focus have been deleted. æKY ODStorageUnit::Exists StorageUnit::Exists StorageUnit->Exists æT Class Method æD ODBoolean Exists( ODPropertyName propertyName, ODValueType valueType, ODValueIndex valueIndex); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns kODTrue if a Property of the given Property Name exists and a Value with the specified valueType or valueIndex exists in the corresponding Property. Otherwise, returns kODFalse. If valueType is kODNULL and valueIndex is 0, this method can be used for testing the existence of Property only. valueIndex is ignored if valueType is not kODNULL. Inputs propertyName Name of a Property. valueType Type of a Value. valueIndex Value Index. Outputs <return> ODBoolean showing whether the specified Property and Value exists. Exceptions Signalled kODErrInvalidName Invalid Property Name. kODErrInvalidType Invalid Value Type. Pre conditions Property Name must be specified. Post conditions The focus of the ODStorageUnit is not changed. æKY ODStorageUnit::ExistsWithCursor StorageUnit::ExistsWithCursor StorageUnit->ExistsWithCursor æT Class Method æD ODBoolean ExistsWithCursor( ODStorageUnitCursor* cursor); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns kODTrue if the given context specified by the cursor exists. Otherwise, returns kODFalse. Inputs cursor ODStorageUnitCursor specifying a context (Property and/or a Value.) Outputs <return> ODBoolean showing whether the specified Property and Value exists. Exceptions Signalled None. Pre conditions None. Post conditions The focus of the ODStorageUnit is not changed. æKY ODStorageUnit::Externalize StorageUnit::Externalize StorageUnit->Externalize æT Class Method æD ODStorageUnit* Externalize(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Resolves all promises in this ODStorageUnit and makes all changes in the Storage Unit persistent. Inputs none Outputs <return> this Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODStorageUnit::Focus StorageUnit::Focus StorageUnit->Focus æT Class Method æD ODStorageUnit* Focus( ODPropertyName propertyName, ODPositionCode propertyPosCode, ODValueType valueType, ODValueIndex valueIndex, ODPositionCode valuePosCode); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation If the propertyName is specified (i.e., not kODNULL), it is used for focusing. Otherwise, the propertyPosCode is used to designate which property to focus on using the current focus. If a valueType is specified (i.e., not kODNULL), it is used to focus the ODStorageUnit. Both valueIndex and valuePosCode are ignored. If valueType is not specified but valueIndex is specified (i.e., not 0), valueIndex is used to focus the ODStorageUnit. valuePosCode is ignored in this case. If neither valueType nor valueIndex is specified, the valuePosCode is used to designate which value to focus on using the current focus. Inputs propertyName focus property name propertyPosCode focus relative property relation valueType focus value type valueIndex focus value index valuePosCode focus relative value relation Outputs <return> this Exceptions Signalled kODErrInvalidProperty No such Property. kODErrInvalidType No Value with this Type. kODErrInvalidValueIndex Invalid value index. kODErrInvalidPosCode Invalid position code. Pre conditions None. Post conditions The StorageUnit is focused on the specified property and value. The current offset is 0. æKY ODStorageUnit::Focus StorageUnit::Focus StorageUnit->Focus æT Class Method æD ODStorageUnit* FocusWithCursor( ODStorageUnitCursor* cursor); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Focus the Storage Unit using the property and value specified by the given ODStorageUnitCursor object. Inputs cursor the cursor to use for focusing Outputs <return> this Exceptions Signalled kODErrInvalidPropertyName No such Property. kODErrInvalidType No Value with such Type. kODErrInvalidValueIndex Invalid Value Index. kODErrInvalidPosCode Invalid position code. Pre conditions None. Post conditions The StorageUnit is focused on the property and/or value specified by the ODStorageUnitCursor object. The current offset is 0. æKY ODStorageUnit::GetDraft StorageUnit::GetDraft StorageUnit->GetDraft æT Class Method æD ODDraft* GetDraft(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns the draft from which this ODStorageUnit is instantiated. Inputs none Outputs <return> ODDraft from which this ODStorageUnit object is created. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODStorageUnit::GetGenerationNumber StorageUnit::GetGenerationNumber StorageUnit->GetGenerationNumber æT Class Method æD ODULong GetGenerationNumber(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Return the generation number of the current value focus. Inputs none Outputs <return> the generation number of the current valuye Exceptions Signalled kODUnfocusedStorageUnit This ODStorageUnit object is not focused to a Value. Pre conditions this ODStorageUnit object is focused to a value. Post conditions None. æKY ODStorageUnit::GetID StorageUnit::GetID StorageUnit->GetID æT Class Method æD ODID GetID(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns the ID of this Storage Unit. Inputs none Outputs <return> the id of the focus Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODStorageUnit::GetIDFromStorageUnitRef StorageUnit::GetIDFromStorageUnitRef StorageUnit->GetIDFromStorageUnitRef æT Class Method æD ODStorageUnitID GetIDFromStorageUnitRef( ODStorageUnitRef ref); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Resolves the given ref to a ODStorageUnitID and returns the ODStorageUnitID. If the specified ref cannot be resolved, an exception is raised. Inputs ref ODStorageUnitRef to be resolved. Outputs <return> the StorageUnitID associated with the given rRef in this value Exceptions Signalled kODUnfocusedStorageUnit this ODStorageUnit object is not focused to a Value. kODErrInvalidStorageUnitRef Invalid Storage Unit Reference. Pre conditions this ODStorageUnit object is focused to a value. Post conditions None. æKY ODStorageUnit::GetName StorageUnit::GetName StorageUnit->GetName æT Class Method æD ODName GetName(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns a copy of the name of the Storage Unit. If the Storage Unit does not have a name, kODNULL is returned. Inputs none Outputs <return> Name of the Storage Unit Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODStorageUnit::GetOffset StorageUnit::GetOffset StorageUnit->GetOffset æT Class Method æD ODULong GetOffset(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns the current offset of the currently focused value. Inputs none Outputs <return> the current offset of the currently focused value Exceptions Signalled kODErrUnfocusedStorageUnit This ODStorageUnit is not focused to a Value. Pre conditions this ODStorageUnit object is focused to a value. Post conditions None. æKY ODStorageUnit::GetPromiseValue StorageUnit::GetPromiseValue StorageUnit->GetPromiseValue æT Class Method æD ODULong GetPromiseValue( in ODValueType valueType, in ODULong offset, in ODULong length, out ODByteArray value, out ODPart sourcePart); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Extracts data placed in the focused value when the promise was created. This does not fulfill the promise. The data is returned in an ODByteArray. The _buffer in the ODByteArray is allocated by ODStorageUnit and needs to be disposed of by the caller using ODDisposePtr. Inputs valueType Value Type of Value to be focused to. offset Offset from which the data should be retrieved. length Length of data to be retrieved. value ODByteArray where data is returned. sourcePart Pointer to the buffer where the sourcePart can be returned. Outputs <return> the actual number of bytes read sourcePart Source Part which has put out the Promise. Exceptions Signalled kODErrUnfocusedStorageUnit This ODStorageUnit object is not focused to a Property. kODErrInvalidType valueType is kODNULL. kODErrCannotAddType Invalid valueType. kODErrInvalidValue Cannot focus to specified Value with valueType. kODErrNotPromise The Value does not contain a Promise. Pre conditions The current storage unit must be focused to a valid property containing a promise of the same type specified in the valueType parameter. Post conditions The promise data (not the data the promise represents) is copied into the supplied value parameter. æKY ODStorageUnit::GetProperty StorageUnit::GetProperty StorageUnit->GetProperty æT Class Method æD ODPropertyName GetProperty(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns the name of the currently focused property. Inputs None. Outputs <return> Property name of the current focus. Exceptions Signalled kODErrUnfocusedStorageUnit this ODStorageUnit is not focused to a Property. Pre conditions this ODStorageUnit object is focused to a property or value. Post conditions None. æKY ODStorageUnit::GetSession StorageUnit::GetSession StorageUnit->GetSession æT Class Method æD ODSession* GetSession(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns the session in which this ODStorageUnit object is running. This is a utility routine Parts should use to retrieve the current ODSession object. Inputs None. Outputs <return> ODSession object in which this ODStorageUnit object is running. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODStorageUnit::GetSize StorageUnit::GetSize StorageUnit->GetSize æT Class Method æD ODULong GetSize(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns the size of the current focus. If the current focus is the whole Storage Unit, the aggregate size of all the Properties and their Values is returned. If the current focus is a Property, the aggregate size of all the Values in the Property is returned. If the current focus is a Value, only the size of the Value is returned. If the current focus is a Promise Value, the Promise is resolved first before the Value size is evaluated. Inputs none Outputs <return> Desired size. Exceptions Signalled kODUnfocusedStorageUnit Pre conditions None. Post conditions None. æKY ODStorageUnit::GetStorageUnitRefIterator StorageUnit::GetStorageUnitRefIterator StorageUnit->GetStorageUnitRefIterator æT Class Method æD ODStorageUnitRefIterator* GetStorageUnitRefIterator(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns an iterator for iterating over all the persistent references created in the currently focused Value. Inputs None. Outputs <return> Iterator used to iterate over all persistent references in the focused Value. Exceptions Signalled None. Pre conditions this ODStorageUnit is focused to a Value. Post conditions None. æKY ODStorageUnit::GetStrongStorageUnitRef StorageUnit::GetStrongStorageUnitRef StorageUnit->GetStrongStorageUnitRef æT Class Method æD void GetStrongStorageUnitRef( in ODStorageUnitID embeddedSUID, out ODStorageUnitRef strongRef); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns a persistent reference to the Storage Unit with the storage unit id embeddedSUID. This persistent reference may be stored within the current value focus of this ODStorageUnit and later used to retrieve the given Storage Unit. The returned ODStorageUnitRef is strong in the sense that the Storage Unit it refers to will be copied in the cloning operation. Inputs embeddedSUID ODStorageUnit ID referring to the Storage Unit whose ref is desired. Outputs strongRef persistent reference to the Storage Unit referred to by embeddedSU. Exceptions Signalled kODUnfocusedStorageUnit Pre conditions this ODStorageUnit object is focused to a value. Storage Units referred to by this ODStorageUnit and embeddedSU must be in the same Draft. Post conditions None. æKY ODStorageUnit::GetType StorageUnit::GetType StorageUnit->GetType æT Class Method æD ODValueType GetType(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns the type of the currently focused value. Inputs none Outputs <return> Type of the focused particular value Exceptions Signalled kODErrInvalidValue kODErrUnfocusedStorageUnit. Pre conditions this ODStorageUnit object is focused to a value. Post conditions None. æKY ODStorageUnit::GetValue StorageUnit::GetValue StorageUnit->GetValue æT Class Method æD ODULong GetValue( in ODULong length, out ODByteArray value); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Reads length bytes from the currently focused value at the current offset and returns the data in a ODByteArray. The _buffer of value is allocated by ODStorageUnit and the client should dispose of it using ODDisposePtr. Inputs length Number of bytes to read into value value Byte array where the data should be returned. Outputs <return> Number of bytes actually read Exceptions Signalled None. Pre conditions this ODStorageUnit object is focused to a value. value is a buffer of length length or more. Post conditions value contains length bytes from offset in the currently focused value. æKY ODStorageUnit::GetWeakStorageUnitRef StorageUnit::GetWeakStorageUnitRef StorageUnit->GetWeakStorageUnitRef æT Class Method æD void GetWeakStorageUnitRef( in ODStorageUnitID embeddedSUID, out ODStorageUnitRef weakRef); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns a persistent reference to the Storage Unit with ID embeddedSUID. This persistent reference may be stored within the current value focus and later used to retrieve the given Storage Unit. This ODStorageUnitRef is weak in the sense that the Storage Unit it refers to will only be copied over in the cloning operation only if there is another Strong Storage Unit Ref referring to it. Inputs embeddedSUID ID of the Storage Unit for which a ref is desired Outputs <return> a ref to the given storageUnit Exceptions Signalled kODUnfocusedStorageUnit this ODStorageUnit is not focused to a Value. Pre conditions this ODStorageUnit object is focused to a value. Post conditions None. æKY ODStorageUnit::IncrementGenerationNumber StorageUnit::IncrementGenerationNumber StorageUnit->IncrementGenerationNumber æT Class Method æD ODULong IncrementGenerationNumber(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Increment and return the generation number of the current value focus. Inputs none Outputs <return> Generation number of the focused Value. Exceptions Signalled kODErrUnfocusedStorageUnit this ODStorageUnit is not focused to a Value. Pre conditions this ODStorageUnit object is focused to a value. Post conditions None. æKY ODStorageUnit::IncrementRefCount StorageUnit::IncrementRefCount StorageUnit->IncrementRefCount æT Class Method æD void IncrementRefCount(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Increments the reference count of this object. Inputs none Outputs none Exceptions Signalled None. Pre conditions None. Post conditions The ref count of this ODStorageUnit object is incremented by 1. æKY ODStorageUnit::InitStorageUnit StorageUnit::InitStorageUnit StorageUnit->InitStorageUnit æT Class Method æD void InitStorageUnit( ODDraft* draft, ODStorageUnitID suid); æC Protection Public. Private within Storage System. This method should only be called by ODDraft::CreateStorageUnit. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Initializes this ODStorageUnit object. Inputs draft the draft of this storage unit suid the id of this storage unit Outputs none Exceptions Signalled None. Pre conditions this is a valid ODStorageUnit. Post conditions this is an initialized ODStorageUnit object. this ODStorageUnit is focused to all Properties. æKY ODStorageUnit::InsertValue StorageUnit::InsertValue StorageUnit->InsertValue æT Class Method æD void InsertValue( ODULong length, ODValue value); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Insert length bytes into the currently focused value at the current offset from the buffer value. If the focused Value is a Promise Value, the Promise is resolved first before insertion is done. Inputs length Number of bytes to write into the focussed value value Buffer of size>= length Outputs none Exceptions Signalled kODErrUnfocusedStorageUnit this ODStorageUnit is not focused to a Value. Pre conditions this ODStorageUnit object is focused to a value. value is a buffer of size length or more. Post conditions length bytes of value have been inserted at the current offset in the currently focused value. æKY ODStorageUnit::Internalize StorageUnit::Internalize StorageUnit->Internalize æT Class Method æD ODStorageUnit* Internalize(); æC Protection Public. Private within Storage System. This method should only be called by ODDraft. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Brings into ephemeral storage from persistent storage, all properties and their values in the current focus. Inputs none Outputs <return> this Exceptions Signalled None. Pre conditions None. Post conditions All properties and values in the current focus have been brought into ephemeral storage from persistent storage. æKY ODStorageUnit::IsPromiseValue StorageUnit::IsPromiseValue StorageUnit->IsPromiseValue æT Class Method æD ODBoolean IsPromiseValue(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns kODTrue if focused Value contains a promise. Otherwise, returns kODFalse. Inputs None. Outputs <return> kODTrue if the focused value contains a promise. otherwise false. Exceptions Signalled None. Pre conditions this ODStorageUnit is focused to a Value. Post conditions None. æKY ODStorageUnit::IsStrongStorageUnitRef StorageUnit::IsStrongStorageUnitRef StorageUnit->IsStrongStorageUnitRef æT Class Method æD ODBoolean IsStrongStorageUnitRef( ODStorageUnitRef ref); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns kODTrue if ref is a strong Storage Unit Ref. Otherwise, it returns kODFalse. Inputs ref ODStorageUnitRef to be tested. Outputs <return> Boolean showing whether the ref is a Strong Storage Unit Ref. Exceptions Signalled None. Pre conditions this ODStorageUnit is focused to a Value. Post conditions None. æKY ODStorageUnit::IsValidStorageUnitRef StorageUnit::IsValidStorageUnitRef StorageUnit->IsValidStorageUnitRef æT Class Method æD ODBoolean IsValidStorageUnitRef( ODStorageUnitRef aRef); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Returns kODTrue if 'aRef' is a valid reference to a storage unit in the context of the current focus, and kODFalse otherwise. Inputs aRef The storage unit reference to test for validity. Outputs <return> kODTrue if 'aRef' is a valid reference and kODFalse otherwise. Exceptions Signalled None. Pre conditions This storage unit is focused to a value. Post conditions None. æKY ODStorageUnit::IsWeakStorageUnitRef StorageUnit::IsWeakStorageUnitRef StorageUnit->IsWeakStorageUnitRef æT Class Method æD ODBoolean IsWeakStorageUnitRef( ODStorageUnitRef ref); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Returns kODTrue if ref is a weak Storage Unit Ref. Otherwise, it returns kODFalse. Inputs ref ODStorageUnitRef to be tested. Outputs <return> Boolean showing whether the ref is a Strong Storage Unit Ref. Exceptions Signalled None. Pre conditions this ODStorageUnit is focused to a Value. Post conditions None. æKY ODStorageUnit::Lock StorageUnit::Lock StorageUnit->Lock æT Class Method æD ODStorageUnitKey Lock( ODStorageUnitKey key); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Sets the status of this ODStorageUnit to locked. Note that this is used for implementing a thread-safety mechanism. In order for the mechanism to work, every thread will have to acquire the lock before any operation on this ODStorageUnit. If the client does not already hold a valid key, the constant kODKeyNotGranted should be passed as the key parameter. Inputs key Previous ODStorageUnitKey acquired, or the value kODKeyNotGranted. Outputs <return> ODStorageUnitKey Exceptions Signalled kODErrStorageUnitLocked ODStorageUnit is already locked. kODErrInvalidStorageUnitKey Invalid ODStorageUnitKey. Pre conditions None. Post conditions An exception is raised if the storage unit is already locked and the input key is anything but kODKeyNotGranted. æKY ODStorageUnit::Purge StorageUnit::Purge StorageUnit->Purge æT Class Method æD ODSize Purge( ODSize size); æC Protection Public. Private within Storage System. This method should only be called by ODDraft::Purge. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Purge memory from ephemeral store until size bytes (not necessarily contiguous) have been freed up. Inputs size Number of bytes to purge Outputs <return> Number of bytes actually purged Exceptions Signalled None. Pre conditions None. Post conditions Either size bytes (not necessarily contiguous) are free in the default heap or all Properties and Values in memory have been flushed out. æKY ODStorageUnit::Release StorageUnit::Release StorageUnit->Release æT Class Method æD ODDraft* Release(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Releases this ODStorageUnit object. This is called when the reference to this ODStorageUnit is no longer needed. Inputs none Outputs <return> fDraft Exceptions Signalled None. Pre conditions None. Post conditions this is no longer a valid ODStorageUnit object. æKY ODStorageUnit::Remove StorageUnit::Remove StorageUnit->Remove æT Class Method æD ODStorageUnit* Remove(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Removes a Value if focused to a Value. Otherwise, removes a property if focused to a property. Otherwise, removes all the properties. Inputs none Outputs <return> this Exceptions Signalled None. Pre conditions None. Post conditions The current focus is undefined. æKY ODStorageUnit::RemoveStorageUnitRef StorageUnit::RemoveStorageUnitRef StorageUnit->RemoveStorageUnitRef æT Class Method æD ODStorageUnit* RemoveStorageUnitRef( ODStorageUnitRef ref); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Removes a ODStorageUnitRef from a Value. Inputs None. Outputs None. Exceptions Signalled kODErrUnfocusedStorageUnit this ODStorageUnit is not focused to a Value. Pre conditions this ODStorageUnit object is focused to a value. ref is a valid ODStorageUnitRef (either strong or weak). Post conditions ref is no longer a valid ODStorageUnitRef in that Value. æKY ODStorageUnit::ResolveAllPromises StorageUnit::ResolveAllPromises StorageUnit->ResolveAllPromises æT Class Method æD void ResolveAllPromises(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation This function resolves all Promises in the Storage Unit. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions The Storage Unit does not contain any promises. æKY ODStorageUnit::SetName StorageUnit::SetName StorageUnit->SetName æT Class Method æD void SetName( ODName name); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Set the name of the Storage Unit. Inputs name the name of the focus Outputs none Exceptions Signalled None. Pre conditions None. Post conditions the name of the Storage Unit is name. æKY ODStorageUnit::SetOffset StorageUnit::SetOffset StorageUnit->SetOffset æT Class Method æD void SetOffset( ODULong offset); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Sets the current offset of the currently focused value to offset. Inputs offset the offset to use witht eh currently focused value Outputs none Exceptions Signalled kODErrUnfocusedStorageUnit this ODStorageUnit is not focused to a Value. Pre conditions this ODStorageUnit is focused to a Value. 0≤offset<size of the focused Value. Post conditions The current offset for value operations on that value is offset. æKY ODStorageUnit::SetPromiseValue StorageUnit::SetPromiseValue StorageUnit->SetPromiseValue æT Class Method æD void SetPromiseValue( ODValueType valueType, ODULong offset, ODULong length, ODValue value ODPart *sourcePart); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Puts the given data into the focused value and make the focused value a promise. Inputs valueType Type of Value the Promise is going to be created in. offset Offset when the Promise data should be stored. length Size of Promise data to be stored. value Buffer containing Promise data. sourcePart The Part which puts out the Promise. Outputs none Exceptions Signalled kODErrUnfocusedStorageUnit this ODStorageUnit is not focused to a Property. kODErrInvalidType valueType is invalid (kODNULL). kODErrCannotAddType Invalid Type. Pre conditions value must be of length bytes long or less. this ODStorageUnit is focused to a Property. Post conditions length bytes of value have been written into offset in the currently focused value. Also, the StorageUnit is updated to reflect that the value is a promise and the needed information is recorded. æKY ODStorageUnit::SetType StorageUnit::SetType StorageUnit->SetType æT Class Method æD void SetType( ODValueType valueType); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Sets the type of the currently focused value. Inputs valueType New type of the focused particular value Outputs none Exceptions Signalled kODErrUnfocusedStorageUnit this ODStorageUnit is not focused to a Value. kODErrInvalidType valueType is invalid (i.e., kODNULL). Pre conditions this ODStorageUnit object is focused to a Value. Post conditions The type of the focused value is valueType. æKY ODStorageUnit::SetValue StorageUnit::SetValue StorageUnit->SetValue æT Class Method æD void SetValue( ODULong length, ODValue value); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Writes length bytes to the currently focused value at the current offset from the buffer value. If length + offset is greater than the current size of the Value, the Value should be grown to accomodate the extra bytes. Inputs length Number of bytes to write into the focussed value value Buffer of size>= length Outputs none Exceptions Signalled kODErrUnfocusedStorageUnit this ODStorageUnit is not focused to a Value. Pre conditions this ODStorageUnit object is focused to a Value. value is a buffer of size length or more. Post conditions length bytes of value have been written into offset in the currently focused value æKY ODStorageUnit::Unlock StorageUnit::Unlock StorageUnit->Unlock æT Class Method æD void Unlock( ODStorageUnitKey key); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Decrements the lock count of this ODStorageUnit by 1. Note that this is used for implementing a thread-safety mechanism. In order for the mechanism to work, every thread will have to acquire the lock before any operation on this ODStorageUnit. Inputs key ODStorageUnitKey acquired from Lock. Outputs None. Exceptions Signalled kODErrInvalidStorageUnitKey Invalid ODStorageUnitKey. kODErrStorageUnitNotLocked The Storage Unit is not locked. Pre conditions None. Post conditions Either an exception is raised or the lock count of this ODStorageUnit is decremented by 1. æKY ODStorageUnit::fCurProperty StorageUnit::fCurProperty æT Class Field æD ODPropertyName æC Persistent form None. æKY ODStorageUnit::fCurValueIndex StorageUnit::fCurValueIndex æT Class Field æD ODValueIndex æC Persistent form None. æKY ODStorageUnit::fCurValueType StorageUnit::fCurValueType æT Class Field æD ODValueType æC Persistent form None. æKY ODStorageUnit::fDoesAutoResolve StorageUnit::fDoesAutoResolve æT Class Field æD ODBoolean æC Persistent form None. æKY ODStorageUnit::fDraft StorageUnit::fDraft æT Class Field æD ODDraft* æC Persistent form None. æKY ODStorageUnit::fHasPropertyLooped StorageUnit::fHasPropertyLooped æT Class Field æD ODBoolean æC Persistent form None. æKY ODStorageUnit::fHasValueLooped StorageUnit::fHasValueLooped æT Class Field æD ODBoolean æC Persistent form None. æKY ODStorageUnit::fID StorageUnit::fID æT Class Field æD ODStorageUnitID æC æKY ODStorageUnitCursorHelp ODStorageUnitCursor StorageUnitCursor æKL ODStorageUnitCursor::ODStorageUnitCursor ODStorageUnitCursor::~ODStorageUnitCursor ODStorageUnitCursor::GetProperty ODStorageUnitCursor::GetValueIndex ODStorageUnitCursor::GetValueType ODStorageUnitCursor::InitStorageUnitCursor ODStorageUnitCursor::SetProperty ODStorageUnitCursor::SetValueIndex ODStorageUnitCursor::SetValueType ODStorageUnitCursor::fCurProperty ODStorageUnitCursor::fCurValue ODStorageUnitCursor::fCurValueType æC Basic Class Documentation ODStorageUnitCursor has no base class. Part developers or Platform developers can subclass this class. Theory of Operation A StorageUnitCursor contains a focus context for a storage unit. It can be used to make thread safe calls to all storage unit methods which would otherwise use the current focus of the storage unit. Invariants Maintained by Class The focus context (i.e., Property Name and Value Type OR Property Name and Value Index) cannot be changed once the object is initialized. æKY ODStorageUnitCursor::ODStorageUnitCursor StorageUnitCursor::ODStorageUnitCursor StorageUnitCursor->ODStorageUnitCursor æT Class Method æD ODStorageUnitCursor(); æC Protection Public. Override policy Derived class can override. Derived class must call base class behavior, before derived class behavior. Basic operation This is the constructor of the class. Inputs None. Outputs None Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODStorageUnitCursor::~ODStorageUnitCursor StorageUnitCursor::~ODStorageUnitCursor StorageUnitCursor->~ODStorageUnitCursor æT Class Method æD ~ODStorageUnitCursor(); æC Protection Public. Override policy Derived class can override. Derived class must call base class behavior, after derived class behavior. Basic operation This is the destructor for the class. Inputs None Outputs None Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODStorageUnitCursor::GetProperty StorageUnitCursor::GetProperty StorageUnitCursor->GetProperty æT Class Method æD void GetProperty( ODPropertyName* propertyName); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the property of this cursor. Inputs None. Outputs propertyName Property Name for the focus context. Exceptions Signalled valueIndex Value index for the focus context. valueIndex Value index for the focus context. Pre conditions None. Post conditions None. æKY ODStorageUnitCursor::GetValueIndex StorageUnitCursor::GetValueIndex StorageUnitCursor->GetValueIndex æT Class Method æD void GetValueIndex( ODValueIndex* valueIndex); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the value index of this cursor. Inputs None. Outputs valueIndex Value Index for the focus context. Exceptions Signalled valueIndex Value index for the focus context. valueIndex Value index for the focus context. Pre conditions None. Post conditions None. æKY ODStorageUnitCursor::GetValueType StorageUnitCursor::GetValueType StorageUnitCursor->GetValueType æT Class Method æD void GetValueType( ODValueType* valueType); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the value type of this cursor. Inputs None. Outputs valueType Value Type for the focus context. Exceptions Signalled valueIndex Value index for the focus context. valueIndex Value index for the focus context. Pre conditions None. Post conditions None. æKY ODStorageUnitCursor::InitStorageUnitCursor StorageUnitCursor::InitStorageUnitCursor StorageUnitCursor->InitStorageUnitCursor æT Class Method æD void InitStorageUnitCursor( ODPropertyName propertyName, ODValueType valueType, ODValueIndex valueIndex); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, before derived class behavior. Basic operation Initializes this object with the focus context. propertyName must be supplied. If valueType is kODNULL and valueIndex is 0, the focus context is to the specified Property. If valueType is not kODNULL, the focus context is the value with the specified type. If valueType is kODNULL and valueIndex is not 0, the focus context is the indexed value. Inputs propertyName Property Name for the focus context. valueType Value Type for the focus context. valueIndex Value index for the focus context. Outputs None Exceptions Signalled kODErrInvalidProperty Property Name is kODNULL. Pre conditions None. Post conditions this object is a fully functional ODStorageUnitCursor (i.e., it can be used for ODStorageUnit::Focus). æKY ODStorageUnitCursor::SetProperty StorageUnitCursor::SetProperty StorageUnitCursor->SetProperty æT Class Method æD void SetProperty( ODPropertyName propertyName); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Set the property of this cursor. Inputs propertyName Property Name Outputs None. Exceptions Signalled valueIndex Value index for the focus context. valueIndex Value index for the focus context. Pre conditions None. Post conditions None. æKY ODStorageUnitCursor::SetValueIndex StorageUnitCursor::SetValueIndex StorageUnitCursor->SetValueIndex æT Class Method æD void SetValueIndex( ODValueIndex* valueIndex); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Set the value index of this cursor. Inputs valueIndex valueIndex Outputs None. Exceptions Signalled valueIndex Value index for the focus context. valueIndex Value index for the focus context. Pre conditions None. Post conditions None. æKY ODStorageUnitCursor::SetValueType StorageUnitCursor::SetValueType StorageUnitCursor->SetValueType æT Class Method æD void SetValueType( ODValueType valueType); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Set the value type of this cursor. Inputs valueType valueType Outputs None. Exceptions Signalled valueIndex Value index for the focus context. valueIndex Value index for the focus context. Pre conditions None. Post conditions None. æKY ODStorageUnitCursor::fCurProperty StorageUnitCursor::fCurProperty æT Class Field æD ODPropertyName æC Persistent form None. æKY ODStorageUnitCursor::fCurValue StorageUnitCursor::fCurValue æT Class Field æD ODValueIndex æC æKY ODStorageUnitCursor::fCurValueType StorageUnitCursor::fCurValueType æT Class Field æD ODValueType æC æKY ODStorageUnitRefIteratorHelp ODStorageUnitRefIterator StorageUnitRefIterator æKL ODStorageUnitRefIterator::ODStorageUnitRefIterator ODStorageUnitRefIterator::~ODStorageUnitRefIterator ODStorageUnitRefIterator::First ODStorageUnitRefIterator::InitStorageUnitRefIterator ODStorageUnitRefIterator::IsNotComplete ODStorageUnitRefIterator::Next ODStorageUnitRefIterator::fNotComplete ODStorageUnitRefIterator::fReference ODStorageUnitRefIterator::fValue æC Basic Class Documentation ODStorageUnitRefIterator is a companion of ODStorageUnit , and is used to iterate over the references in a Value. ODStorageUnitRefIterator has no base class. The class documented here (ODStorageUnitRefIterator) is an abstract base class. Container Suite Implementors should subclass ODStorageUnitRefIterator to provide the functionality of a OpenDoc StorageUnit Reference Iterator for their Container Suite. Parts can instantiate this object when they need to iterate over all the persistent references of a Value. Theory of Operation Given the state of the focused ODStorageUnit object, ODStorageUnitRefIterator allows the developer to iterate over all the references in a Value, using the iterator's First(), Next() and IsNotComplete() methods. Invariants Maintained by Class ODStorageUnitRef cannot be created or deleted during iteration. ODStorageUnit must remain focused to the Value on which ODStorageUnitRefIterator is iterating. The client of this class must check to see whether the reference returned by First or Next is valid or not by calling IsNotComplete. æKY ODStorageUnitRefIterator::ODStorageUnitRefIterator StorageUnitRefIterator::ODStorageUnitRefIterator StorageUnitRefIterator->ODStorageUnitRefIterator æT Class Method æD ODStorageUnitRefIterator(); æC Protection Public. Override policy Derived class must override. Derived class must call base class behavior, before derived class behavior. Basic operation Constructs the iterator. Inputs None. Outputs None Exceptions Signalled None. Pre conditions None. Post conditions A properly constructed iterator. æKY ODStorageUnitRefIterator::~ODStorageUnitRefIterator StorageUnitRefIterator::~ODStorageUnitRefIterator StorageUnitRefIterator->~ODStorageUnitRefIterator æT Class Method æD ~ODStorageUnitRefIterator(); æC Protection Public. Override policy Derived class must override. Derived class must call base class behavior, after derived class behavior. Basic operation This is the destructor of the class. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions this is a valid ODStorageUnitRefIterator object. Post conditions this is no longer a valid ODStorageUnitRefIterator object. æKY ODStorageUnitRefIterator::First StorageUnitRefIterator::First StorageUnitRefIterator->First æT Class Method æD void First( out ODStorageUnitRef ref); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns the first reference in the Value if such a reference exists. If no such reference exists, the return value is undefined. Inputs None Outputs ref The first ODStorageUnitRef in the focused Value of the ODStorageUnit. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODStorageUnitRefIterator::InitStorageUnitRefIterator StorageUnitRefIterator::InitStorageUnitRefIterator StorageUnitRefIterator->InitStorageUnitRefIterator æT Class Method æD void InitStorageUnitRefIterator( ODStorageUnit* storageUnit); æC Protection Public. Override policy Derived class must override. Derived class must call base class behavior, before derived class behavior. Basic operation Initializes this ODStorageUnitRefIterator object. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODStorageUnitRefIterator::IsNotComplete StorageUnitRefIterator::IsNotComplete StorageUnitRefIterator->IsNotComplete æT Class Method æD ODBoolean IsNotComplete(); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns kODTrue if the iteration is not complete, kODFalse otherwise. Inputs None Outputs <return> Boolean showing whether the iteration is incomplete. Exceptions Signalled None. Pre conditions A constructed object of this class. Post conditions Result contains kODTrue if there are more references, kODFalse otherwise. æKY ODStorageUnitRefIterator::Next StorageUnitRefIterator::Next StorageUnitRefIterator->Next æT Class Method æD void Next( out ODStorageUnitRef ref); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns the next reference in the Value if such a reference exists. If no such reference exists, the return value is undefined. Inputs None Outputs ref The next reference in the Value. Exceptions Signalled None. Pre conditions First() has been called. Post conditions Result contains the next reference. æKY ODStorageUnitRefIterator::fNotComplete StorageUnitRefIterator::fNotComplete æT Class Field æD ODBoolean fNotComplete; æC Persistent form None. æKY ODStorageUnitRefIterator::fReference StorageUnitRefIterator::fReference æT Class Field æD CMReference fReference æC Persistent form None. æKY ODStorageUnitRefIterator::fValue StorageUnitRefIterator::fValue æT Class Field æD CMValue fValue; æC æKY ODStorageUnitViewHelp ODStorageUnitView StorageUnitView æKL ODStorageUnitView::ODStorageUnitView ODStorageUnitView::~ODStorageUnitView ODStorageUnitView::AddProperty ODStorageUnitView::AddValue ODStorageUnitView::CloneInto ODStorageUnitView::CopyTo ODStorageUnitView::CreateStorageUnitRefIterator ODStorageUnitView::DeleteValue ODStorageUnitView::Externalize ODStorageUnitView::GetCursor ODStorageUnitView::GetGenerationNumber ODStorageUnitView::GetID ODStorageUnitView::GetIDFromStorageUnitRef ODStorageUnitView::GetName ODStorageUnitView::GetOffset ODStorageUnitView::GetPromiseValue ODStorageUnitView::GetProperty ODStorageUnitView::GetSize ODStorageUnitView::GetStorageUnit ODStorageUnitView::GetStorageUnitRefIterator ODStorageUnitView::GetStrongStorageUnitRef ODStorageUnitView::GetType ODStorageUnitView::GetValue ODStorageUnitView::GetWeakStorageUnitRef ODStorageUnitView::IncrementGenerationNumber ODStorageUnitView::InitStorageUnitView ODStorageUnitView::InsertValue ODStorageUnitView::Internalize ODStorageUnitView::IsPromiseValue ODStorageUnitView::IsStrongStorageUnitRef ODStorageUnitView::IsValidStorageUnitRef ODStorageUnitView::IsWeakStorageUnitRef ODStorageUnitView::Purge ODStorageUnitView::Remove ODStorageUnitView::RemoveStorageUnitRef ODStorageUnitView::SetName ODStorageUnitView::SetOffset ODStorageUnitView::SetPromiseValue ODStorageUnitView::SetType ODStorageUnitView::SetValue ODStorageUnitView::fCursor ODStorageUnitView::fSU æC Basic Class Documentation This class is derived from ODObject. This class is implemented by Platform Implementors. It should be able to work with ODStorageUnit and ODStorageUnitCursor of any Container Suite. Most methods of this class is not intended to be overriden. Theory of Operation A ODStorageUnitView provides an easy and thread-safe way to access a specific Property or a Value of a Storage Unit. Many of the ODStorageUnit methods are duplicated in ODStorageUnitView. A ODStorageUnitView method in general obtains the semaphore to ensure thread-safety, focuses the associated ODStorageUnit and calls the corresponding ODStorageUnit method and releases the semaphore. Due to this relations between ODStorageUnitView and ODStorageUnit, ODStorageUnitView methods behave exactly the same as their corresponding ODStorageUnit methods. That also means they return the same exceptions. (For this reason, the documentation for exceptions is omitted in this class. Please refer to documentation for ODStorageUnit to get the full list of exceptions.) ODStorageUnitView objects can be constructed directly (i.e., using the constructor and Init method), or they can be obtained by a request to a ODStorageUnit object. They may be deleted direcly by clients. Parts can instantiate ODStorageUnitView. Invariants Maintained by Class The ODStorageUnit and ODStorageUnitCursor of a StorageUnitView are specified in the InitStorageUnitView method, and these values never change. æKY ODStorageUnitView::ODStorageUnitView StorageUnitView::ODStorageUnitView StorageUnitView->ODStorageUnitView æT Class Method æD ODStorageUnitView(); æC Protection Public. Override policy Derived class can override. Derived class must call base class behavior, before derived class behavior. Basic operation This function is the constructor of the ODStorageUnitView object. Inputs None. Outputs <return> this Exceptions Signalled None. Pre conditions None. Post conditions this is an uninitialized ODStorageUnitView object. æKY ODStorageUnitView::~ODStorageUnitView StorageUnitView::~ODStorageUnitView StorageUnitView->~ODStorageUnitView æT Class Method æD ~ODStorageUnitView(); æC Protection Public. Override policy Derived class can override. Derived class must call base class behavior, after derived class behavior. Basic operation This is the destructor of the ODStorageUnitView object. This method releases the ODStorageUnit with which this ODStorageUnitView object is associated and deletes the cursor which provides the context. Note that this method does not externalize the ODStorageUnit. Inputs none Outputs none Exceptions Signalled None. Pre conditions None. Post conditions this is no longer a valid ODStorageUnitView object. æKY ODStorageUnitView::AddProperty StorageUnitView::AddProperty StorageUnitView->AddProperty æT Class Method æD ODStorageUnitView* AddProperty( ODPropertyName propertyName); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Adds a Property to the Storage Unit this ODStorageUnitView is viewing. The resulting ODStorageUnit will have the new Property as the focus even though the ODStorageUnitView will maintain the cursor. Inputs ODPropertyName Outputs none Exceptions Signalled None. Pre conditions Its ODStorageUnitCursor corresponds to a particular Property of the ODStorageUnit. Post conditions The viewed ODStorageUnit has a focus on the new Property. æKY ODStorageUnitView::AddValue StorageUnitView::AddValue StorageUnitView->AddValue æT Class Method æD ODStorageUnitView* AddValue( ODValueType type); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Adds a Value to the ODStorageUnit it is viewing. The resulting ODStorageUnit will have a new Value with the focus on it. This ODStorageUnitView will maintain its cursor. Inputs none Outputs none Exceptions Signalled None. Pre conditions Its ODStorageUnitCursor corresponds to a particular value of the ODStorageUnit. Post conditions The viewed ODStorageUnit has a veiw on the added Value. æKY ODStorageUnitView::CloneInto StorageUnitView::CloneInto StorageUnitView->CloneInto æT Class Method æD void CloneInto( ODDraftKey key, ODStorageUnit* destSU, ODStorageUnitID scopeID); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Deep-copy all Properties and Values of the Storage Unit this ODStorageUnitView is viewing to the specified destStorageUnit. In order to avoid copying extra Storage Units during the deep-copy, a scopeID may be specified. If scopeID is not 0, only those Storage Units reachable from storage unit or object with scopeID will be copied. If scopeID is 0, all the Storage Units reachable from this Storage Unit/object will be copied. Note that the actual copying may not be completed until after EndClone is finished. Inputs key ODDraftKey identifying the Clone transaction. destStorageUnit Destination Storage Unit to where this Stoage Unit is copied. scopeID All Storage Units cloned from this point on should be within the scope of this ODFrame. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODStorageUnitView::CopyTo StorageUnitView::CopyTo StorageUnitView->CopyTo æT Class Method æD void CopyTo( ODStorageUnit* toSU); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Shallow copies properties and values from the ODStorageUnit this ODStorageUnitView is viewing to toSU. Inputs toSU the storage unit to which data is to be copied Outputs none Exceptions Signalled None. Pre conditions None. Post conditions All properties and values of the ODStorageUnit this ODStorageUnitView object is viewing have the respective properties and values in toSU. The focus of the viewed ODStorageUnit is undefined. æKY ODStorageUnitView::CreateStorageUnitRefIterator StorageUnitView::CreateStorageUnitRefIterator StorageUnitView->CreateStorageUnitRefIterator æT Class Method æD ODStorageUnitRefIterator CreateStorageUnitRefIterator(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, before derived class behavior. Basic operation This function returns a ODStorageUnitRefIterator which allows the caller to access all the Storage Unit References in the focused value. Inputs None. Outputs <return> ODStorageUnitRefIterator which allows the caller to access all the Storage Unit References in the focused value Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODStorageUnitView::DeleteValue StorageUnitView::DeleteValue StorageUnitView->DeleteValue æT Class Method æD void DeleteValue( ODULong length); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Delete length bytes at the current offset (inclusive) in the focused Value. If the focused Value is a Promise Value, the Promise is resolved first before insertion is done. Inputs offset the offset into the focussed value length the length of bytes to delete from the focussed value Outputs none Exceptions Signalled None. Pre conditions Its ODStorageUnitCursor corresponds to a particular value of the ODStorageUnit. Post conditions length bytes at the current offset in the currently focused value have been deleted. The focus of the viewed ODStorageUnit is on the context specified by the cursor of this ODStorageUnitView object. æKY ODStorageUnitView::Externalize StorageUnitView::Externalize StorageUnitView->Externalize æT Class Method æD ODStorageUnitView* Externalize(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Makes all changes of the ODStorageUnit this ODStorageUnitView object is viewing persistent. Inputs none Outputs <return> this Exceptions Signalled None. Pre conditions None. Post conditions All properties and values in the associated ODStorageUnit have persistently written out and are no longer dependent on their ephemeral storage representation. The focus of the viewed ODStorageUnit is undefined. æKY ODStorageUnitView::GetCursor StorageUnitView::GetCursor StorageUnitView->GetCursor æT Class Method æD ODStorageUnitCursor* GetCursor(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the ODStorageUnitCursor used to focus the ODStorageUnit. Inputs none Outputs <return> ODStorageUnitCursor which provides the context for this ODStorageUnitView object. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODStorageUnitView::GetGenerationNumber StorageUnitView::GetGenerationNumber StorageUnitView->GetGenerationNumber æT Class Method æD ODULong GetGenerationNumber(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, before derived class behavior. Basic operation Returns the generation number of the Value this ODStorageUnitView object is viewing. Inputs none Outputs <return> Generation number of the focused value Exceptions Signalled None. Pre conditions Its ODStorageUnitCursor corresponds to a particular value of the ODStorageUnit. Post conditions The focus of the viewed ODStorageUnit is on the context specified by the cursor of this ODStorageUnitView object. æKY ODStorageUnitView::GetID StorageUnitView::GetID StorageUnitView->GetID æT Class Method æD ODID GetID(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns the persistent ID of the ODStorageUnit object this ODStorageUnitView object is viewing. Inputs none Outputs <return> ID of the ODStorageUnit object this object is viewing. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODStorageUnitView::GetIDFromStorageUnitRef StorageUnitView::GetIDFromStorageUnitRef StorageUnitView->GetIDFromStorageUnitRef æT Class Method æD ODStorageUnitID GetIDFromStorageUnitRef( ODStorageUnitRef ref); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Resolves the given ref to a ODStorageUnitID and returns the ODStorageUnitID. If the specified ref cannot be resolved, an exception is raised. Inputs ref persistent reference to be resolved. Outputs ODStorageUnitID ID of the embedded StorageUnit. Exceptions Signalled kODNotValueFocussed Pre conditions Its ODStorageUnitCursor corresponds to a particular value of the ODStorageUnit. ref must be generated by GetStrongStorageUnitRef or GetWeakStorageUnitRef. Post conditions The focus of the viewed ODStorageUnit is on the context specified by the cursor of this ODStorageUnitView object. æKY ODStorageUnitView::GetName StorageUnitView::GetName StorageUnitView->GetName æT Class Method æD ODName* GetName(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, before derived class behavior. Basic operation Returns the name of the Storage Unit this ODStorageUnitView is viewing. Inputs none Outputs <return> the name of the focus Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODStorageUnitView::GetOffset StorageUnitView::GetOffset StorageUnitView->GetOffset æT Class Method æD ODULong GetOffset(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, before derived class behavior. Basic operation Return the offset of the Value this ODStorageUnitVeiw is viewing. Inputs none Outputs <return> Offset of the current Value. Exceptions Signalled kODNotValueFocussed Pre conditions Its ODStorageUnitCursor corresponds to a particular Value of the Storage Unit. Post conditions None. æKY ODStorageUnitView::GetPromiseValue StorageUnitView::GetPromiseValue StorageUnitView->GetPromiseValue æT Class Method æD ODULong GetPromiseValue( in ODValueType valueType, in ODULong offset, in ODULong length, out ODByteArray value, out ODPart sourcePart); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Get the promise data in the Value this ODStorageUnitView object is viewing. This does not resolve the promise. The _buffer is ODByteArray is allocated by ODStorageUnitView and needs to be disposed of by the caller using ODDisposePtr. Inputs valueType Type of the Value containing the desired promise data. offset Offset from where the desired promise data should be retrieved. length Length of desired promise data. value ODByteArray used to contain the desired promise data. Outputs <return> Number of bytes read. value Buffer containing the promise data. Exceptions Signalled None. Pre conditions Its ODStorageUnitCursor corresponds to a particular value of the ODStorageUnit. Post conditions length bytes have been read from offset in the value of the given valueType into the value parameter. The focus of the viewed ODStorageUnit is on the context specified by the cursor of this ODStorageUnitView object. æKY ODStorageUnitView::GetProperty StorageUnitView::GetProperty StorageUnitView->GetProperty æT Class Method æD ODPropertyName GetProperty(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns the Property Name in the cursor of this ODStorageView object. Inputs None. Outputs <return> Property name. Exceptions Signalled None. Pre conditions Its ODStorageUnitCursor corresponds to a particular property or value of the ODStorageUnit. Post conditions The focus of the viewed ODStorageUnit is on the context specified by the cursor of this ODStorageUnitView object. æKY ODStorageUnitView::GetSize StorageUnitView::GetSize StorageUnitView->GetSize æT Class Method æD ODULong GetSize(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns the size of the focused Property or Value this ODStorageUnitView object is viewing. Inputs None. Outputs <return> Size of the focused Property or Value this ODStorageUnitView object is viewing. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODStorageUnitView::GetStorageUnit StorageUnitView::GetStorageUnit StorageUnitView->GetStorageUnit æT Class Method æD ODStorageUnit* GetStorageUnit(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the ODStorageUnit that this ODStorageUnitView is viewing. The returned ODStorageUnit should be focused using the ODStorageUnitCursor stored in this ODStorageUnitView object. Inputs none Outputs <return> ODStorageUnit this ODStorageUnitView is viewing. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODStorageUnitView::GetStorageUnitRefIterator StorageUnitView::GetStorageUnitRefIterator StorageUnitView->GetStorageUnitRefIterator æT Class Method æD ODStorageUnitRefIterator* GetStorageUnitRefIterator(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns an iterator for iterating over all the persistent references created in the Value this ODStorageUnitRefIterator is viewing. Inputs None. Outputs <return> Iterator used to iterate over all persistent references in the focused Value. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODStorageUnitView::GetStrongStorageUnitRef StorageUnitView::GetStrongStorageUnitRef StorageUnitView->GetStrongStorageUnitRef æT Class Method æD void GetStrongStorageUnitRef( in ODStorageUnitID embeddedSUID, out ODStorageUnitRef strongRef); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns a persistent reference to the Storage Unit refered to by embeddedSUID. This persistent reference may be stored within the Value this ODStorageUnitView is viewing and later used to retrieve the given Storage Unit. The returned ODStorageUnitRef is strong in the sense that the Storage Unit it refers to will be copied in the cloning operation. Inputs embeddedSUID ODStorageUnitID referring to the Storage Unit whose persistent reference is desired. Outputs strongRef persistent reference to the Storage Unit referred to by embeddedSU. Exceptions Signalled None. Pre conditions Its ODStorageUnitCursor corresponds to a particular value of the ODStorageUnit. Post conditions The focus of the viewed ODStorageUnit is on the context specified by the cursor of this ODStorageUnitView object. æKY ODStorageUnitView::GetType StorageUnitView::GetType StorageUnitView->GetType æT Class Method æD ODValueType GetType(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, before derived class behavior. Basic operation Returns the type of the Value in the cursor of this ODStorageUnitView object. Inputs none Outputs <return> the type of the focused particular value Exceptions Signalled None. Pre conditions Its ODStorageUnitCursor corresponds to a particular value of the ODStorageUnit. Post conditions The focus of the viewed ODStorageUnit is on the context specified by the cursor of this ODStorageUnitView object. æKY ODStorageUnitView::GetValue StorageUnitView::GetValue StorageUnitView->GetValue æT Class Method æD ODULong GetValue( in ODULong length, out ODByteArray value); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, before derived class behavior. Basic operation Reads length bytes from current offset of the Value this ODStorageUnitView object is viewing and returns the value in an ODByteArray. The _buffer in ODByteArray is allocated by ODStorageUnitView and needs to be disposed of by the caller using ODDisposePtr. If the Value contains a promise, the promise is resolved first before the reading is done. If offset+length is bigger than the size of the Value, only the bytes from the offset (inclusive) to the end of the Value will be read rendering the actual number of bytes read smaller than length. Inputs offset the offset into the focussed value length the length of bytes to read into value value ODByteArray where data is to be returned. Outputs <return> Number of bytes actually read. value Buffer containing the read data. Exceptions Signalled None. Pre conditions Its ODStorageUnitCursor corresponds to a particular value of the ODStorageUnit. value is a buffer of length length or more Post conditions value has read length bytes from offset in the cursor-focused value The focus of the viewed ODStorageUnit is on the context specified by the cursor of this ODStorageUnitView object. æKY ODStorageUnitView::GetWeakStorageUnitRef StorageUnitView::GetWeakStorageUnitRef StorageUnitView->GetWeakStorageUnitRef æT Class Method æD void GetWeakStorageUnitRef( in ODStorageUnitID embeddedSUID, out ODStorageUnitRef weakRef); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns a persistent reference to the Storage Unit refered to by embeddedSUID. This persistent reference may be stored within the Value this ODStorageUnitView object is viewing and later used to retrieve the given Storage Unit. This ODStorageUnitRef is weak in the sense that the Storage Unit it refers to will only be copied over in the cloning operation only if there is another Strong Storage Unit Ref referring to it. Inputs embeddedSU ODStorageUnit object referring to the Storage Unit whose persistent reference is desired. Outputs weakRef Persistent reference to the Storage Unit referred to by embeddedSU. Exceptions Signalled None. Pre conditions Its ODStorageUnitCursor corresponds to a particular value of the ODStorageUnit. Post conditions The focus of the viewed ODStorageUnit is on the context specified by the cursor of this ODStorageUnitView object. æKY ODStorageUnitView::IncrementGenerationNumber StorageUnitView::IncrementGenerationNumber StorageUnitView->IncrementGenerationNumber æT Class Method æD ODULong IncrementGenerationNumber(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Increment and returns the generation number of the Value this ODStorageUnitView object is viewing. Inputs none Outputs <return> Generation number of the Storage Unit Exceptions Signalled None. Pre conditions Its ODStorageUnitCursor corresponds to a particular value of the ODStorageUnit. Post conditions The focus of the viewed ODStorageUnit is on the context specified by the cursor of this ODStorageUnitView object. æKY ODStorageUnitView::InitStorageUnitView StorageUnitView::InitStorageUnitView StorageUnitView->InitStorageUnitView æT Class Method æD void InitStorageUnitView( ODStorageUnit* storageUnit, ODStorageUnitCursor* cursor); æC Protection Public. Override policy Derived class can override. Derived class must call base class behavior, before derived class behavior. Basic operation Initializes this ODStorageUnitView by storing the parameters. Inputs storageUnit ODStorageUnit this ODStorageUnitView is associated with. cursor Context (Property and/or Value) in which the ODStorageUnitView methods should work. Outputs none Exceptions Signalled None. Pre conditions None. Post conditions this is an initialized ODStorageUnitView object. æKY ODStorageUnitView::InsertValue StorageUnitView::InsertValue StorageUnitView->InsertValue æT Class Method æD void InsertValue( ODULong length, ODValue value); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, after derived class behavior. Basic operation Inserts length bytes at the current offset in the value this ODStorageUnitView object is viewing. If the focused Value contains a Promise, the Promise is resolved first before insertion is done. Inputs length the length of bytes to write into the focussed value value a buffer of length>= length Outputs none Exceptions Signalled None. Pre conditions Its ODStorageUnitCursor corresponds to a particular value of the ODStorageUnit. value is a buffer of length length or more Post conditions length bytes of value have been inserted at offset in the currently focused value The focus of the viewed ODStorageUnit is on the context specified by the cursor of this ODStorageUnitView object. æKY ODStorageUnitView::Internalize StorageUnitView::Internalize StorageUnitView->Internalize æT Class Method æD ODStorageUnitView* Internalize(); æC Protection Public. Private within Storage System. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Internalizes the ODStorageUnit object this ODStorageUnitView object is viewing. Inputs none Outputs <return> this Exceptions Signalled None. Pre conditions None. Post conditions all properties and values in the focus have been brought into ephemeral storage from persistent storage æKY ODStorageUnitView::IsPromiseValue StorageUnitView::IsPromiseValue StorageUnitView->IsPromiseValue æT Class Method æD ODBoolean IsPromiseValue(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns kODTrue if the Value this ODStorageUnitView object is viewing contains a Promise. Otherwise, returns kODFalse. If the focused Value is a Promise, the Promise will not be resolved by this call. Inputs none Outputs <return> ODBoolean showing whether the focused Value contains a Promise. Exceptions Signalled None. Pre conditions Its ODStorageUnitCursor corresponds to a particular value of the ODStorageUnit. Post conditions The focus of the viewed ODStorageUnit is on the context specified by the cursor of this ODStorageUnitView object. æKY ODStorageUnitView::IsStrongStorageUnitRef StorageUnitView::IsStrongStorageUnitRef StorageUnitView->IsStrongStorageUnitRef æT Class Method æD ODBoolean IsStrongStorageUnitRef( ODStorageUnitRef ref); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns kODTrue if ref is a strong ODStorageUnitRef. Otherwise, returns kODFalse. Inputs ref ODStorageUnitRef to be tested. Outputs <return> Boolean showing whether ref is a strong ODStorageUnitRef. Exceptions Signalled None. Pre conditions Its ODStorageUnitCursor corresponds to a particular value of the ODStorageUnit. Post conditions The focus of the viewed ODStorageUnit is on the context specified by the cursor of this ODStorageUnitView object. æKY ODStorageUnitView::IsValidStorageUnitRef StorageUnitView::IsValidStorageUnitRef StorageUnitView->IsValidStorageUnitRef æT Class Method æD ODBoolean IsValidStorageUnitRef( ODStorageUnitRef ref); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns kODTrue if ref is a valid ODStorageUnitRef. Otherwise, returns kODFalse. Inputs ref ODStorageUnitRef to be tested. Outputs <return> Boolean showing whether the ref is a valid ODStorageUnitRef. Exceptions Signalled None. Pre conditions Its ODStorageUnitCursor corresponds to a particular value of the ODStorageUnit. Post conditions The focus of the viewed ODStorageUnit is on the context specified by the cursor of this ODStorageUnitView object. æKY ODStorageUnitView::IsWeakStorageUnitRef StorageUnitView::IsWeakStorageUnitRef StorageUnitView->IsWeakStorageUnitRef æT Class Method æD ODBoolean IsWeakStorageUnitRef( ODStorageUnitRef ref); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Returns kODTrue if ref is a weak ODStorageUnitRef. Otherwise, returns kODFalse. Inputs ref ODStorageUnitRef to be tested. Outputs <return> Boolean showing whether the ref is a weak ODStorageUnitRef. Exceptions Signalled None. Pre conditions Its ODStorageUnitCursor corresponds to a particular value of the ODStorageUnit. Post conditions The focus of the viewed ODStorageUnit is on the context specified by the cursor of this ODStorageUnitView object. æKY ODStorageUnitView::Purge StorageUnitView::Purge StorageUnitView->Purge æT Class Method æD ODSize Purge( ODSize size); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, before derived class behavior. Basic operation Purge memory from ephemeral store until size bytes (not necessarily contiguous) have been freed up. Inputs size the number of bytes to purge Outputs <return> the number of bytes actually purged Exceptions Signalled None. Pre conditions None. Post conditions Either size bytes (not necessarily contiguous) are free in the default heap or all properties and values in the associated ODStorageUnit have been flushed out. æKY ODStorageUnitView::Remove StorageUnitView::Remove StorageUnitView->Remove æT Class Method æD ODStorageUnitView* Remove(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Removes the value or property this ODStorageUnitView object is viewing. This is a dangerous operation in the sense that this method makes the view of this ODStorageUnitView invalid. This method should be used with caution. Inputs none Outputs <return> this Exceptions Signalled None. Pre conditions Its ODStorageUnitCursor corresponds to a particular property or value of the ODStorageUnit. Post conditions the property or value at the cursor focus is removed The focus of the viewed ODStorageUnit is undefined. æKY ODStorageUnitView::RemoveStorageUnitRef StorageUnitView::RemoveStorageUnitRef StorageUnitView->RemoveStorageUnitRef æT Class Method æD ODStorageUnitView* RemoveStorageUnitRef( ODStorageUnitRef ref); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Removes a ODStorageUnitRef from a Value. Inputs ref persistent reference to a Storage Unit. Outputs <return> this ODStorageUnitView object. Exceptions Signalled None. Pre conditions Its ODStorageUnitCursor corresponds to a particular value of the ODStorageUnit. ref is a valid ODStorageUnitRef (either strong or weak). Post conditions ref is no longer a valid ODStorageUnitRef in that Value. æKY ODStorageUnitView::SetName StorageUnitView::SetName StorageUnitView->SetName æT Class Method æD void SetName( ODName name); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, after derived class behavior. Basic operation Set the name of the Storage Unit this ODStorageUnitView is viewing. Inputs name the name of the focus Outputs none Exceptions Signalled None. Pre conditions None. Post conditions the name of the focus = name æKY ODStorageUnitView::SetOffset StorageUnitView::SetOffset StorageUnitView->SetOffset æT Class Method æD void SetOffset( ODULong offset); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, after derived class behavior. Basic operation Sets the offset of the value this ODStorageUnitView object is viewing. Inputs offset Offset to use with the focused value Outputs none Exceptions Signalled None. Pre conditions Its ODStorageUnitCursor corresponds to a particular value of the Storage Unit. Post conditions the current offset for value operations is offset. æKY ODStorageUnitView::SetPromiseValue StorageUnitView::SetPromiseValue StorageUnitView->SetPromiseValue æT Class Method æD void SetPromiseValue( ODValueType valueType, ODULong offset, ODULong length, ODValue value); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Put the given data into the value this ODStorageUnitView is viewing and make the viewed value a promise. Inputs valueType Type of Value to be containing the Promise data. offset Offset from which the data should be written. length Length of data to be written. value Buffer containing the data to be written. Outputs none Exceptions Signalled None. Pre conditions Its ODStorageUnitCursor corresponds to a particular value of the ODStorageUnit. Post conditions length bytes of value have been written into offset in the focused value. Also, the StorageUnit is updated to reflect that the value is a promise. The focus of the viewed ODStorageUnit is on the context specified by the cursor of this ODStorageUnitView object. æKY ODStorageUnitView::SetType StorageUnitView::SetType StorageUnitView->SetType æT Class Method æD void SetType( ODValueType valueType); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, after derived class behavior. Basic operation Sets the type of the Value of the Storage Unit this ODStorageUnitView is viewing. Inputs valueType Type of the focused Value. Outputs Exceptions Signalled Exceptions Signalled None. Pre conditions Its ODStorageUnitCursor corresponds to a particular value of the ODStorageUnit. Post conditions the type of that value = valueType The focus of the viewed ODStorageUnit is on the context specified by the cursor of this ODStorageUnitView object. æKY ODStorageUnitView::SetValue StorageUnitView::SetValue StorageUnitView->SetValue æT Class Method æD void SetValue( ODULong length, ODValue value); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, after derived class behavior. Basic operation Write length bytes to the current offset of the Value this ODStorageUnitView is viewing. If length + offset is greater than the current size of the Value, the Value should be grown to accomodate the extra bytes. Inputs length the length of bytes to write into the focussed value value a buffer of length>= length Outputs None Exceptions Signalled None. Pre conditions Its ODStorageUnitCursor corresponds to a particular value of the ODStorageUnit. value is a buffer of length length or more Post conditions length bytes of value have been written into offset in the focused Value. The focus of the viewed ODStorageUnit is on the context specified by the cursor of this ODStorageUnitView object. æKY ODStorageUnitView::fCursor StorageUnitView::fCursor æT Class Field æD ODStorageUnitCursor* æC Persistent form None. æKY ODStorageUnitView::fSU StorageUnitView::fSU æT Class Field æD ODStorageUnit* æC æKY ODTransformHelp ODTransform Transform æKL ODTransform::Copy ODTransform::CopyFrom ODTransform::GetMatrix ODTransform::GetOffset ODTransform::GetPreScaleOffset ODTransform::GetQDOffset ODTransform::GetScale ODTransform::GetType ODTransform::HasMatrix ODTransform::Invert ODTransform::InvertPoint ODTransform::InvertShape ODTransform::IsQDOffset ODTransform::IsSameAs ODTransform::MoveBy ODTransform::NewTransform ODTransform::PostCompose ODTransform::PreCompose ODTransform::ReadFrom ODTransform::Reset ODTransform::ScaleBy ODTransform::ScaleDownBy ODTransform::SetMatrix ODTransform::SetOffset ODTransform::SetQDOffset ODTransform::somInit ODTransform::somUninit ODTransform::TransformPoint ODTransform::TransformShape ODTransform::WriteTo ODTransform::fInverseMatrix ODTransform::fMatrix æC Basic Class Documentation Base class: ODObject. ODTransform objects are used to define transformations between coordinate spaces in different ODFrames and ODFacets. More background information can be found in the ODFrame and ODFacet class documentation. Theory of Operation ODTransforms use a 3x3 matrix to perform 2-d transformations of ODPoints. Transforms can be concatenated by multiplying their matrices, resulting in an "aggregate transform". See any standard computer graphics text for gory details. It is possible for subclasses of ODTransform to be defined that do not use transformation matrices. These might perform more complex operations like morphing or wrapping around a 3D surface. Invariants Maintained by Class fMatrix holds a transformation matrix. fInverseMatrix points to a cached inverse-transformation matrix (the inverse of fMatrix). It is generated when needed, and cleared when fMatrix changes or a memory-purge happens. æKY ODTransform::Copy Transform::Copy Transform->Copy æT Class Method æD ODTransform* Copy(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Creates and returns a new ODTransform object identical to the receiver. This is a factory method for transforms: do not call "new ODTransform" yourself. Inputs None. Outputs <return> A new ODTransform object identical to the receiver. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODTransform::CopyFrom Transform::CopyFrom Transform->CopyFrom æT Class Method æD void CopyFrom( ODTransform* sourceTransform); æC Protection Public. No restrictions. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Changes the receiver into an exact copy of the sourceTransform. Inputs sourceTransform Pointer to another ODTransform object. Caller's storage responsability. Outputs None. Exceptions Signalled None. Pre conditions sourceTransform is a valid ODTransform. Post conditions This object is now equivalent to the sourceTransform object. æKY ODTransform::GetMatrix Transform::GetMatrix Transform->GetMatrix æT Class Method æD void GetMatrix( ODMatrix *m ); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Copies the entire transformation matrix as an ODMatrix into the 'm' parameter. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODTransform::GetOffset Transform::GetOffset Transform->GetOffset æT Class Method æD void GetOffset( ODPoint *offset ); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the offset portion of the transformation in the 'offset' parameter. This corresponds to the first two elements of the bottom row of the matrix. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODTransform::GetPreScaleOffset Transform::GetPreScaleOffset Transform->GetPreScaleOffset æT Class Method æD void GetPreScaleOffset( ODPoint *offset ); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the offset scaled down by the scale portion of the transform. This is useful for clients that want to transform their data by offsetting first and then scaling: this is the offset they should use. It doesn't make much sense if the transformation involves rotation, skewing, or perspective. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODTransform::GetQDOffset Transform::GetQDOffset Transform->GetQDOffset æT Class Method æD Point GetQDOffset(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the offset of this transformation as a QuickDraw point. This is like GetOffset, except that the coordinates are rounded to the nearest integer. Inputs None. Outputs <return> Transformation's offset, rounded to the nearest integer. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODTransform::GetScale Transform::GetScale Transform->GetScale æT Class Method æD void GetScale( ODPoint *scale ); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the scaling factor of this transformation in the 'scale' parameter. This is equivalent to the [0,0] and [1,1] elements of the matrix. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODTransform::GetType Transform::GetType Transform->GetType æT Class Method æD ODTransformType GetType(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, after derived class behavior. Basic operation Returns the type of transformation, as one of the values of the ODTransformType enumeration. Inputs None. Outputs <return> The type of this transformation. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODTransform::HasMatrix Transform::HasMatrix Transform->HasMatrix æT Class Method æD ODBoolean HasMatrix(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Use HasMatrix to find out if an ODTransform is based on a transformation matrix. (If not, the GetMatrix call will raise an exception.) All direct instances of ODTransform are matrix-based and this call always returns true. However, developers may subclass ODTransform to implement complex transforms (like morphs) that cannot be represented as matrices. Inputs None. Outputs <return> kODTrue if transform has a matrix, else kODFalse. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODTransform::Invert Transform::Invert Transform->Invert æT Class Method æD ODTransform* Invert(); æC Protection Public. No restrictions. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Turns this ODTransform object into its inverse. Returns the receiver so you can easily append another call to this one. Inputs None. Outputs <return> Pointer to this ODTransform object which is turned into its Inverse. Exceptions Signalled kODErrOutOfMemory Not enough memory to allocate inverse matrix. kODErrTransformErr Transformation is not invertible. Pre conditions The transform is invertible. Post conditions Receiver now represents the inverse transformation. æKY ODTransform::InvertPoint Transform::InvertPoint Transform->InvertPoint æT Class Method æD ODPoint InvertPoint( ODPoint point); æC Protection Public. No restrictions. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation The opposite of TransformPoint: transforms a point by the inverse of this transform. The transform itself is left unchanged, unlike Invert. Inputs point ODPoint data structure; Outputs <return> transformed point. Exceptions Signalled kODErrOutOfMemory Not enough memory to allocate inverse matrix. kODErrTransformErr Not invertible. Pre conditions The transform is invertible. Post conditions The returned Point is the input point transformed by the inverse of the transform. æKY ODTransform::InvertShape Transform::InvertShape Transform->InvertShape æT Class Method æD void InvertShape( ODShape *shape ); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Transforms the shape through the inverse of this transformation. This is equivalent to the InverseTransform method in ODShape. Inputs None. Outputs None. Exceptions Signalled kODErrTransformErr Transformation is not invertible. Pre conditions Transformation is invertible. Post conditions Shape is transformed. æKY ODTransform::IsQDOffset Transform::IsQDOffset Transform->IsQDOffset æT Class Method æD ODBoolean IsQDOffset(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns kODTrue if the transformation is an exact QuickDraw transformation: a pure offset with integral coordinates. This may be too strict a definition for many purposes: QuickDraw code can still easily draw via an offset transform with non-integral coordinates, since the offset will be rounded. So GetType may be a more appropriate method to call. But if you want to make sure your coordinates are exact you can call this method. Inputs None. Outputs <return> kODTrue if the transform is a pure integer offset, else kODFalse. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODTransform::IsSameAs Transform::IsSameAs Transform->IsSameAs æT Class Method æD ODBoolean IsSameAs( ODTransform* compareTransform); æC Protection Public. No restrictions. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Comparison of two ODTransform objects. Inputs compareTransform Pointer to an ODTransform object. Outputs <return> kODTrue if the transforms are the same, else kODFalse. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODTransform::MoveBy Transform::MoveBy Transform->MoveBy æT Class Method æD ODTransform* MoveBy( ODPoint offset ); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Offsets the transformation by the given amount. This is just like post-composing the transform with an offset matrix. Inputs offset Amount to offset by. Outputs <return> Returns the receiver. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODTransform::NewTransform Transform::NewTransform Transform->NewTransform æT Class Method æD ODTransform* NewTransform(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns a new, initialized identity transform. This is a factory method for transforms: do not call "new ODTransform" yourself. Inputs None. Outputs <return> <return> Exceptions Signalled kODErrOutOfMemory Not enough memory to create a new transform. Pre conditions None. Post conditions None. æKY ODTransform::PostCompose Transform::PostCompose Transform->PostCompose æT Class Method æD ODTransform* PostCompose( ODTransform* transform); æC Protection Public. No restrictions. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Update this transform according to the matrix multiplication: this = this * transform. Returns a pointer to the transform object ('this') as a convenience to the caller. Inputs transform Pointer to another ODTransform. Outputs <return> Pointer to this ODTransform object. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODTransform::PreCompose Transform::PreCompose Transform->PreCompose æT Class Method æD ODTransform* PreCompose( ODTransform* transform); æC Protection Public. No restrictions. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Update this transform according to the matrix multiplication: this = transform * this. Returns a pointer to the transform object ('this') as a convenience to the caller. Inputs transform Pointer to ODTransform. Outputs <return> Pointer to this ODTransform object. Exceptions Signalled kODErrNumericError Pre conditions None. Post conditions None. æKY ODTransform::ReadFrom Transform::ReadFrom Transform->ReadFrom æT Class Method æD void ReadFrom( ODStorageUnit* ); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Reads the transformation matrix from a storage unit, which must be pre-focused on a particular property. The matrix will be read from the kODTransform value of that property. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODTransform::Reset Transform::Reset Transform->Reset æT Class Method æD ODTransform* Reset(); æC Protection Public. No restrictions. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Turns this ODTransform object into the Identity transform. Returns the receiver for easy concatenation with other operations. Inputs None. Outputs <return> Pointer to this ODTransform object. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODTransform::ScaleBy Transform::ScaleBy Transform->ScaleBy æT Class Method æD ODTransform* ScaleBy( ODPoint scale ) ; æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Scales the transformation. Inputs scale Scaling factor (x and y) Outputs <return> Returns the receiver. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODTransform::ScaleDownBy Transform::ScaleDownBy Transform->ScaleDownBy æT Class Method æD ODTransform* ScaleDownBy( ODPoint scale ); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation This is the inverse of Scale: it scales by the reciprocal of the input. Inputs scale Inverse scaling factor Outputs <return> Returns the receiver. Exceptions Signalled kODErrTransformErr scale.x or scale.y is zero. Pre conditions Neither coordinate of the scale factor is equal to zero. Post conditions None. æKY ODTransform::SetMatrix Transform::SetMatrix Transform->SetMatrix æT Class Method æD ODTransform* SetMatrix( ODMatrix *matrix ); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Makes the receiver's transformation equivalent to the supplied transformation matrix. If the matrix is NULL this is equivalent to calling Reset. Inputs matrix Points to an input ODMatrix specifying the new transform. Outputs <return> Returns the receiver. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODTransform::SetOffset Transform::SetOffset Transform->SetOffset æT Class Method æD ODTransform* SetOffset( ODPoint offset ); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Makes the receiver a pure offset (or translation) with the given coordinates. Inputs offset Coordinates of the offset Outputs <return> Returns the receiver. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODTransform::SetQDOffset Transform::SetQDOffset Transform->SetQDOffset æT Class Method æD ODTransform* SetQDOffset( Point ); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Turns the transform into a pure offset with the given integer coordinates. Inputs point Coordinates of the offset Outputs <return> Returns the receiver. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODTransform::somInit Transform::somInit Transform->somInit æT Class Method æD somInit(); æC Protection Public. Only factory methods should directly construct ODTransform objects. Override policy Derived class can override. Derived class must call base class behavior, before derived class behavior. Basic operation Constructs a new ODTransform object representing the identity transform. Inputs None. Outputs <return> an ODTransform object. Exceptions Signalled kODErrOutOfMemory Pre conditions Enough memory is available to allocate the ODTransform object. Post conditions The object is allocated and initialized. æKY ODTransform::somUninit Transform::somUninit Transform->somUninit æT Class Method æD somUninit(); æC Protection Public. Don't call directly; use delete instead. Override policy Derived class can override. Derived class must call base class behavior, after derived class behavior. Basic operation Deletes an ODTransform object. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions Object has been created. Post conditions None. æKY ODTransform::TransformPoint Transform::TransformPoint Transform->TransformPoint æT Class Method æD ODPoint TransformPoint( ODPoint point); æC Protection Public. No restrictions. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Maps a point from a source coordinate space to a destination coordinate space by applying this transform. Inputs point Input point to be transformed. Outputs <return> transformed point. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODTransform::TransformShape Transform::TransformShape Transform->TransformShape æT Class Method æD void TransformShape( ODShape *shape ); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Transforms the shape through this transformation. This is equivalent to the Transform method in ODShape. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODTransform::WriteTo Transform::WriteTo Transform->WriteTo æT Class Method æD void WriteTo( ODStorageUnit* ); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Writes the transform (as a matrix) to the storage unit. The storage unit should be pre-focused to a particular property; the matrix will be written in the kODTransform value of that property. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODTransform::fInverseMatrix Transform::fInverseMatrix æT Class Field æD ODMatrix *fInverseMatrix; æC æKY ODTransform::fMatrix Transform::fMatrix æT Class Field æD ODMatrix fMatrix; æC æKY ODTranslationHelp ODTranslation Translation æKL ODTranslation::ODTranslation ODTranslation::~ODTranslation ODTranslation::CanTranslate ODTranslation::GetISOTypeFromPlatformType ODTranslation::GetPlatformTypeFromISOType ODTranslation::GetTranslationOf ODTranslation::InitTranslation ODTranslation::Purge ODTranslation::Translate ODTranslation::TranslateView æC Basic Class Documentation ODTranslation is not derived from any class. However, it depends on the system service which provides data translation. The system service should also allow users to query what kind of translation is available. The class documented here is an abstract base class. Platform implementors must subclass this class to provide the OpenDoc Translation functionalities on their platforms. This object is instantiated by ODSession at session startup time only. Parts should not instantiate this object even though Parts are the main client of this object. Theory of Operation ODTranslation provides data translation capability to OpenDoc documents and their parts. At the process' startup time, a ODTranslation object is instantiated and stored with the ODSession. Whenever a part needs the translation service, it can acquire the ODTranslation object through the ODSession object. The translation service can be triggered when a part does not know how to handle data of an unfamiliar type (e.g., when importing data from ODClipboard or ODDragAndDrop). The part can ask ODTranslation to find out to what types the data can be translated. Alternatively, the part may ask ODTranslation whether the data can be translated to one or more types that the part can handle. If the desired types are available, the part can then have ODTranslation done the actual conversion of data. Invariants Maintained by Class The translation methods provided by ODTranslation should include all those provided by the system translation service. æKY ODTranslation::ODTranslation Translation::ODTranslation Translation->ODTranslation æT Class Method æD ODTranslation(); æC Protection Public. Private between ODSession and ODTranslation. This method should only be called by ODSession::InitSession. Override policy Derived class must override. Derived class must call base class behavior. Basic operation This function is the constructor of the ODTranslation object. It is called once at the process' startup time. Inputs None Outputs None Exceptions Signalled None. Pre conditions None. Post conditions this is an uninitialized ODTranslation object. æKY ODTranslation::~ODTranslation Translation::~ODTranslation Translation->~ODTranslation æT Class Method æD ~ODTranslation(); æC Protection Public. Private between ODSession and ODTranslation. This method should only be called by ODSession::~ODSession or the equivalent shutdown method. Override policy Derived class must override. Derived class must call base class behavior. Basic operation This function is the destructor of the ODTranslation object. It is called once when the process quits. It closes the system translation service. Inputs None Outputs None Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODTranslation::CanTranslate Translation::CanTranslate Translation->CanTranslate æT Class Method æD ODTranslateResult CanTranslate( ODValueType fromType); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation This functions returns kODTrue if the tranlation facility can translate fromType. Inputs fromType type of data to be translated. Outputs <return> ODTranslateResult showing whether a certain type can be translated. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODTranslation::GetISOTypeFromPlatformType Translation::GetISOTypeFromPlatformType Translation->GetISOTypeFromPlatformType æT Class Method æD ODType GetISOTypeFromPlatformType( ODPlatformType platformType, ODPlatformTypeSpace typeSpace); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Returns the ISO type corresponding to the argument platform type in the context of the argument type space. Inputs platformType The platform specific type typeSpace The context in which to interprete the type Outputs <result> The ISO type Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODTranslation::GetPlatformTypeFromISOType Translation::GetPlatformTypeFromISOType Translation->GetPlatformTypeFromISOType æT Class Method æD ODPlatformType GetPlatformTypeFromISOType( ODType type); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation This function returns the platform type corresponding to the argument ISO type. On the Macintosh, if no platform type corresponds from the argument type, a value of zero is returned. Inputs type The ISO type. Outputs <result> The platform type. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODTranslation::GetTranslationOf Translation::GetTranslationOf Translation->GetTranslationOf æT Class Method æD ODTypeList* GetTranslationOf( ODValueType fromType); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation This function returns a ODTypeList that contains all the types to which fromType can be translated. If translation cannot be done on fromType, an empty set is returned. Inputs fromType Type of the source data. Outputs <return> A list of types that can be translated to from the source data. Exceptions Signalled kODErrOutOfMemory Cannot create a ODTypeList because the system is running out of memory. Pre conditions None. Post conditions fromType is unchanged. æKY ODTranslation::InitTranslation Translation::InitTranslation Translation->InitTranslation æT Class Method æD void InitTranslation( ODSession* session); æC Protection Public. Private between ODSession and ODTranslation. This method should only be called by ODSession::InitSession. Override policy Derived class must override. Derived class must call base class behavior. Basic operation Initializes the system translation service. It is called once at the process' startup time. Inputs session Access to global objects. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions this is an initialized ODTranslation object. æKY ODTranslation::Purge Translation::Purge Translation->Purge æT Class Method æD ODSize Purge( ODSize size); æC Protection Public. Private between ODSession and ODTranslation. This should only be called by ODSession. Override policy Derived class must override. Derived class can call base class behavior. Basic operation Purges memory from ephemeral store until size bytes (not necessarily contiguous) have been freed up. Inputs size Number of bytes to purge. Outputs <return> Number of bytes actually purged. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODTranslation::Translate Translation::Translate Translation->Translate æT Class Method æD ODTranslateResult Translate( in ODValueType fromType, in ODByteArray fromData, in ODValueType toType, out ODByteArray toData); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Translates the data in the ODByteArray fromData and returns the translated data in the ODByteArray toData. The _buffer of ODByteArray is allocated by ODTranslation and needs to be disposed of by the caller using ODDisposePtr. Inputs fromData Source data to be translated. fromType Type of source data. toType Type of data desired. Outputs toData ByteArray used to contain translated data. <return> Result of translation (i.e., whether the translation succeeds). Exceptions Signalled kODErrOutOfMemory Buffer pointed to by toData is not large enough to contain the translated data. kODErrCannotTranslate Data cannot be translated using the ODTranslationMethod. kODErrCannotDisposeTranslationMethod TranslationMethod cannot be disposed. Pre conditions None. Post conditions The content referred to by fromData is unchanged. æKY ODTranslation::TranslateView Translation::TranslateView Translation->TranslateView æT Class Method æD ODTranslateResult TranslateView( ODStorageUnitView* fromView, ODStorageUnitView* toView); æC Protection Public. Override policy Derived class must override. Derived class cannot call base class behavior. Basic operation Translates the Value viewed by fromView and stores the translated data in the Value viewed by toView. Inputs fromView Value which contains the data to be translated. Outputs <return> Result of translation. toView Value where the translated data should be stored. Exceptions Signalled kODErrBadTranslationMethod Corrupted ODTranslationMethod. kODErrOutOfMemory Cannot create a buffer to contain the translated data because the system is running out of memory. kODErrCannotTranslate Data cannot be translated using the ODTranslationMethod. kODErrCannotDisposeTranslationMethod TranslationMethod cannot be disposed. Pre conditions None. Post conditions None. æKY ODTypeListHelp ODTypeList TypeList æKL ODTypeList::ODTypeList ODTypeList::~ODTypeList ODTypeList::AddLast ODTypeList::Contains ODTypeList::Count ODTypeList::CreateTypeListIterator ODTypeList::InitTypeList ODTypeList::Remove ODTypeList::fHeap ODTypeList::fList æC Basic Class Documentation ODTypeList is an ordered collection class for ODType objects. ODTypeList has no base class. Theory of Operation ODTypeList is an ordered collection of ODTypes. Users of this class can add and remove types , query the existence of a type, and get the number of types in the list. Parts may create instances of this class. Subclassing of ODTypeList is not anticipated. The main clients of this class are ODTranslation and parts. ODTranslation class uses ODTypeList as parameters to its functions. Parts can use ODTypeList to store a set of Types for repeated uses. ODTypeList uses OpenDoc's private collection class. Invariants Maintained by Class Every item in a ODTypeList object is unique. Therefore, a ODTypeList object contains a set of different ODTypes. A ODTypeList object can contain zero or more ODTypes. In other words, the type set can either be empty or non-empty. æKY ODTypeList::ODTypeList TypeList::ODTypeList TypeList->ODTypeList æT Class Method æD ODTypeList(); æC Protection Public. Override policy Derived class cannot override. Derived class must call base class behavior, before derived class behavior. Basic operation This function is the constructor of the class. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions Members are initialized to a known state. æKY ODTypeList::~ODTypeList TypeList::~ODTypeList TypeList->~ODTypeList æT Class Method æD ~ODTypeList(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation This method is the destructor of the class. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions The list has been created. Post conditions None. æKY ODTypeList::AddLast TypeList::AddLast TypeList->AddLast æT Class Method æD void AddLast( ODType type); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Adds a copy of the argument type to the end of the list. If the type is already present in the list, no action is taken. Inputs type The type to add to the list. Outputs None. Exceptions Signalled kODErrOutOfMemory Could not add the argument type to the list. kODErrInvalidType Argument type is not a valid ODType. Pre conditions The list has been initialized. Post conditions The list contains the argument type. æKY ODTypeList::Contains TypeList::Contains TypeList->Contains æT Class Method æD ODBoolean Contains( ODType type); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Test this list for the presence of the argument type. Inputs type The type to test for inclusion in the list. Outputs <return> kODTrue if the argument type is in the list and kODFalse otherwise. Exceptions Signalled None. Pre conditions The list has been initialized. Post conditions None. æKY ODTypeList::Count TypeList::Count TypeList->Count æT Class Method æD ODULong Count(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, before derived class behavior. Basic operation This function returns the number of types in the list. If the list is empty, zero is returned. Inputs None. Outputs <return> Number of types in the list. Exceptions Signalled None. Pre conditions The list has been initialized. Post conditions None. æKY ODTypeList::CreateTypeListIterator TypeList::CreateTypeListIterator TypeList->CreateTypeListIterator æT Class Method æD ODTypeListIterator* CreateTypeListIterator(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Return an iterator for this list. The client should dispose of the iterator using the delete operator. Inputs None. Outputs <return> An iterator for this list. Exceptions Signalled kODErrOutOfMemory Could not create the iterator. Pre conditions The list has been initialized. Post conditions None. æKY ODTypeList::InitTypeList TypeList::InitTypeList TypeList->InitTypeList æT Class Method æD void InitTypeList( ODTypeList* initList); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Initializes data members and sets the list to a copy of 'initList'. Inputs initList A list of ODTypes from which to initialize this object. A kODNULL value results in an intially empty list. Outputs None. Exceptions Signalled kODErrOutOfMemory Could not initialize the list. Pre conditions The list has been created. Post conditions The list has been initialized to a copy of 'initList'. æKY ODTypeList::Remove TypeList::Remove TypeList->Remove æT Class Method æD void Remove( ODType type); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, before derived class behavior. Basic operation Removes the argument type from the list. If the type is not in the list, no action is taken. Inputs type Type to be removed. Outputs None. Exceptions Signalled None. Pre conditions The list has been initialized. Post conditions The argument type is not in the list. æKY ODTypeList::fHeap TypeList::fHeap æT Class Field æD ODHeap æC æKY ODTypeList::fList TypeList::fList æT Class Field æD OrderedCollection* æC æKY ODTypeListIteratorHelp ODTypeListIterator TypeListIterator æKL ODTypeListIterator::ODTypeListIterator ODTypeListIterator::~ODTypeListIterator ODTypeListIterator::First ODTypeListIterator::IsNotComplete ODTypeListIterator::Next ODTypeListIterator::fIterator ODTypeListIterator::fTypeList æC Basic Class Documentation ODTypeListIterator is an iterator for the class ODTypeList. ODTypeListIterator has no base class. Theory of Operation This class is used to iterate over the elements of a ODTypeList instance in order. Iteration is forward only, from first to last. The iteration can be restarted at any time by calling the First method. If the ODTypeList instance is modified during the iteration, First or Next will throw an exception. When an exception is thrown, the iterator cannot be used further, and should be destroyed. Parts should create an ODTypeListIterator by calling the CreateTypeListIterator method of the ODTypeList instance to be iterated over. The iterator should be disposed using the delete operator. Subclassing of ODTypeListIterator is not anticipated. The implementation of ODTypeListIterator uses OpenDoc's private collection class. Invariants Maintained by Class æKY ODTypeListIterator::ODTypeListIterator TypeListIterator::ODTypeListIterator TypeListIterator->ODTypeListIterator æT Class Method æD ODTypeListIterator( ODTypeList* typeList); æC Protection Public. For use by ODTypeList only. Iterators should be created by calling ODTypeList::CreateTypeListIterator. Override policy Derived class cannot override. Derived class must call base class behavior, during derived class behavior. Basic operation Class instance constructor. Inputs typeList The list of ODTypes to iterate over. Outputs <return> <return> Exceptions Signalled kODErrOutOfMemory Could not construct this instance. Pre conditions None. Post conditions The iterator is initialized to iterate over the argument list. æKY ODTypeListIterator::~ODTypeListIterator TypeListIterator::~ODTypeListIterator TypeListIterator->~ODTypeListIterator æT Class Method æD ~ODTypeListIterator(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Class instance destructor. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions The iterator has been created. Post conditions None. æKY ODTypeListIterator::First TypeListIterator::First TypeListIterator->First æT Class Method æD ODType First(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Initiates iteration and returns the first ODType object in the list. This method does not return a copy of the item, so the client must not dispose the returned object. After creating an iterator using ODTypeList::CreateTypeListIterator, call this method once, then call Next repeatedly to iterate through all items in the list. First can be called at any time to restart the iteration. Inputs None. Outputs <return> The first ODType object in the list. If the list is empty kODNULL is returned, although the client should test for completion by calling IsNotComplete. Exceptions Signalled kODErrIteratorOutOfSync The ODTypeList instance was changed during the iteration. Pre conditions The iterator was created. Post conditions The first item in the list is returned, or kODNULL if the list is empty. æKY ODTypeListIterator::IsNotComplete TypeListIterator::IsNotComplete TypeListIterator->IsNotComplete æT Class Method æD ODBoolean IsNotComplete(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Test if iteration is complete. Inputs None. Outputs <return> Returns kODTrue if the last call to First or Next returned a valid ODType element, and kODFalse otherwise. Exceptions Signalled None. Pre conditions The list has been created and First() has been called to start the iteration. Post conditions None. æKY ODTypeListIterator::Next TypeListIterator::Next TypeListIterator->Next æT Class Method æD ODType Next(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the next element from the ordered list. This method does not return a copy of the item, so the client must not dispose the returned object. First() should be called prior to this routine to start the iteration. Next can be called repeatedly to iterate through the remaining items in the list. IsNotComplete returns kODFalse if the preceeding call to Next did not return an item from the list. Inputs None. Outputs <return> The item in the ordered list after the last item returned by First or Next since the iteration was started. If the iteration is complete kODNULL is returned, although the client should test for completion by calling IsNotComplete. Exceptions Signalled kODErrIteratorOutOfSync The ODTypeList instance was changed during the iteration. Pre conditions First has been called to start the iteration. Post conditions None. æKY ODTypeListIterator::fIterator TypeListIterator::fIterator æT Class Field æD OrderedCollectionIterator* æC æKY ODTypeListIterator::fTypeList TypeListIterator::fTypeList æT Class Field æD ODTypeList* æC æKY ODTypesHelp ODTypes Types æKL Data Interchange Types Data Interchange - ODPasteAsResult Types Data Interchange - ODLinkInfo Types Data Interchange - ODLinkInfoResult Types General Types Imaging Types Messaging Subsystem Types Storage System Types UI Subsystem Types æKY Data Interchange Types æKL ODLinkKey ODChangeID ODCloneKind ODPlatformType ODLinkStatus ODDropResult ODPasteAsMergeSetting ODLinkInfoAction ODDragResult æC These scalar types are used by classes providing data interchange in OpenDoc. æKY ODLinkKey æC ODLinkKey is used to provide thread-safe access to link content. It is required by every method of class ODLink and class ODLinkSource that return or modify the link's content storage unit. Values of this type are not inspectable. Values of this type are created by ODLink::Lock and ODLinkSource::Lock. æKY ODChangeID æC Values of this type are associated with clipboard content and with linked content. Two ODChangeID values associated with different versions of the same content may be tested for equality, but any other use of these values is meaningless. For example, the change identification associated with the clipboard may be tested for equality with a previous clipboard change id to see if the contents have changed, but it is invalid to test if the current change id is greater than a previous value. æKY ODCloneKind æC An enumerated type used to indicate the desired semantics of a clone operation. Values of this type are passed to ODDraft::BeginClone. The values are kODCloneCopy, specifying copy semantics into an intermediate draft such as the clipboard or a drag-and-drop container; kODCloneCut, specifying cut semantics into an intermediate draft; kODClonePaste, specifying paste semantics from an intermediate draft; kODCloneDropCopy, specifying copy semantics at the destination of a drop and used instead of kODClonePaste; kODCloneDropMove, specifying move semantics at the destination of a drop and used instead of kODClonePaste. æKY ODPlatformType æC A cover for the platform-specific type used to identify data formats for data interchange. æKY ODLinkStatus æC An enumerated type specifying the link context of a frame. This type has three values. The value kODInLinkDestination describes a frame that is embedded in content that is the destination of a link. The value kODInLinkSource describes a frame that is embedded in content that is the source of a link (perhaps in several source links that overlap). The value kODNotInLink indicates a frame that is not embedded in linked content. æKY ODDropResult æC An enumerated type indicating the result of a drag. The four values are kODDropCopy, meaning a successful synchronous drop with copy semantics; kODDropMove, meaning a successful synchronous drop with move semantics; kODDropFail, meaning an unsuccessful synchronous drop, and kODDropUnfinished meaning that an asynchronous drag was started. æKY ODPasteAsMergeSetting æC An enumerated type used to communicate settings to the ShowPasteAs Dialog methods of ODClipboard and ODDragAndDrop. Values specify if merging and/or embedding is allowed, and whether the initial setting is merge or embed. Values are kODPasteAsMerge (enable merge and embed; merge is the default), kODPasteAsEmbed (enable merge and embed; embed is the default), kODPasteAsMergeOnly (don't allow embedding), and kODPasteAsEmbedOnly (don't allow merging). æKY ODLinkInfoAction æC An enumerated type indicating the action requested by the user in dismissing a link info dialog. Values are kODLinkInfoCancel, kODLinkInfoOK, kODLinkInfoBreakLink, kODLinkInfoUpdateNow, kODLinkInfoFindSource. æKY ODDragResult æC Result code showing whether a drop is allowed in the specified facet. æKY Data Interchange - ODPasteAsResult Types æKL pasteLinkSetting autoUpdateSetting mergeSetting selectedView selectedKind translateKind editor æC A structure used to return the user's choices from ShowPasteAsDialog. æKY pasteLinkSetting æC An ODBoolean value; kODTrue if a link was chosen. æKY autoUpdateSetting æC An ODBoolean value; kODTrue if automatic link updates were choosen. Relevant only if pasteLinkSetting is kODTrue. æKY mergeSetting æC An ODBoolean value; kODTrue if incorporation was chosen and kODFalse if embedding was chosen. æKY selectedView æC An ODTypeToken value; the view type chosen. æKY selectedKind æC An ODType value; the kind chosen for merging or embedding. æKY translateKind æC An ODType value; if data translation was chosen, this this the available type that should be translated to selectedKind. If an available kind was chosen this field will be kODNULL. æKY editor æC An ODEditor field only relevant when embedding, i.e. when mergeSetting is kODFalse. Set to kODNoEditor when no specific editor was choosen, otherwise, the preferred editor to bind to the part after embedding. æKY Data Interchange - ODLinkInfo Types æKL kind creationTime changeTime change autoUpdate æC A structure containing information about a link destination. Supplied by parts as a parameter to ODLink::ShowLinkDestinationInfo. æKY kind æC The ODType used by the destination of the link. æKY creationTime æC The date and time of the creation of this link destination. æKY changeTime æC The date and time of the source change last read by this destination. æKY change æC The change ID of the source change last read by this destination. æKY autoUpdate æC An ODBoolean value; kODTrue if this destination updates automatically and kODFalse otherwise. æKY Data Interchange - ODLinkInfoResult Types æKL action autoUpdate æC A structure used to return the user's choices from ODLinkSource::ShowLinkSourceInfo and ODLink::ShowLinkDestinationInfo. æKY action æC An ODLinkInfoAction value indicating the button pressed by the user to dismiss the dialog. æKY autoUpdate æC An ODBoolean value reflecting the users choice for the update settings in the dialog. æKY General Types æKL ODISOStr ODType ODValueType ODFixed ODFract ODBoolean ODHeap ODSByte ODUByte ODUShort ODSShort ODULong ODSLong ODPtr ODFileSpec ODScriptCode ODFileRefNum ODEditor ODContainerSuite ODIconFamily æC These scalar types are used widely in OpenDoc. æKY ODISOStr æC A string type composed of 7 bit ascii terminated by a zero byte. Since the first zero byte terminates the string, NULLs may not be embedded. æKY ODType æC The type used generically within OpenDoc to represent storage unit types, focus types, and value types. An ODType is an ODISOStr. æKY ODValueType æC Identifies data value types. An ODType. æKY ODFixed æC ODFixed represents non-integer numbers in the range [-32768, 32768) as 32-bit values whose high 16 bits (including a sign bit) represent the integer part, and whose low 16 bits represent a fractional part. In effect, the “binary point” is in the middle of the number. An integer can be converted to ODFixed by shifting it left 16 bits. An ODFixed can be rounded to an integer by adding 0x8000 (0.5) and shifting it right 16 bits. You can convert between ODFixed and floating-point by multiplying or dividing by 65536.0. ODFixeds can be added or subtracted from each other as though they were regular integers. Multplication or division are trickier. ODFixed is identical to the Macintosh "Fixed" type, and the Macintosh has several Toolbox routines, such as FixMul and FixDiv, for doing fixed-point arithmetic. æKY ODFract æC ODFract is, like ODFixed, a 32-bit fixed-point number used to represent non-integer values. However, it has only two bits to the left of the “binary point”, instead of 16. It can only represent values in the range [-2,2), but it has much higher precision than an ODFixed. Use 30-bit shifts to convert between ODFracts and integers, or a scaling factor of 1073741824.0 to convert between ODFracts and floating-point numbers. (ODFract is identical to the Macintosh "Fract" type, and the Toolbox has routines such as FracMul and FracDiv for doing arithmetic on Fract values.) æKY ODBoolean æC A boolean value. æKY ODHeap æC A memory heap pointer. æKY ODSByte æC A signed 8-bit value. æKY ODUByte æC An unsigned 8-bit value. æKY ODUShort æC An unsigned 16-bit value. æKY ODSShort æC A signed 16-bit value. æKY ODULong æC An unsigned 32-bit value. æKY ODSLong æC A signed 32-bit value. æKY ODPtr æC An OD pointer. A void*. æKY ODFileSpec æC A struct specifying a file on disk. æKY ODScriptCode æC An international script code. æKY ODFileRefNum æC A file reference number. An ODSShort . æKY ODEditor æC A type identifying a specific part editor. æKY ODContainerSuite æC A type idetifying a specific container suite. æKY ODIconFamily æC This is a platform specific type which contains a collection of icons for rendering a part or other content in iconic format. On the Macintosh, this is an IconSuite. æKY Imaging Types æKL ODCoordinate ODPoint ODRect ODPolygon ODMatrix ODGraphicsSystem ODPlatformShape ODPlatformTransform ODGeometryMode ODHighlight ODFramePosition ODInfoType æC The majority of these data types are used to represent geometric structures in OpenDoc, such as distances, positions, bounding boxes and shapes. (Shapes at runtime are usually represented by ODShape objects with an opaque data format, but they can be accessed and stored in one of the forms listed here.) Several of these types are used to describe non-geometric information about ODFrames and ODFacets. æKY ODCoordinate æC ODCoordinate represents spatial coordinates in documents and windows. It's an ODFixed, which usually implies 16 integer and 16 fractional bits, but internally you can partition the bits up however you please provided you shift the values appropriately when talking to the outside world. (If you are using a graphics system, such as QuickDraw GX, that handles arbitrary transformations, you can do this automatically by assigning a scaling factor to your internal transform.) æKY ODPoint æC An ODPoint represents a spatial point in a window or document. In two-dimensional imaging models (all that exist so far for OpenDoc) it is a pair of ODCoordinates. Macintosh developers accustomed to QuickDraw should take note that the x coordinate appears first. Also note that the coordinates are, of course, fixed-point numbers. On the other hand, an ODPoint is identical to a QuickDraw GX gxPoint structure. æKY ODRect æC ODRect represents a rectangle whose sides are aligned with the axes of the current coordinate system. It is represented as four ODCoordinates giving the left, top, right and bottom extent of the rectangle (in that order.) By convention a rectangle does not include its bottom or right edge; this makes it easier to have adjacent yet non-overlapping rectangles. Macintosh developers accustomed to QuickDraw should note that the left coord comes before the top, and likewise the right comes before the bottom. On the other hand, an ODRect is identical to a QuickDraw GX gxRect structure. æKY ODPolygon æC An ODPolygon represents a two-dimensional shape made out of straight edges. It is the platform-independent interchange format for all shapes, including frame shapes. An ODPolygon consists of one or more contours, each of which is a closed loop of ODPoints connected by straight edges. Polygons with multiple contours may be composed of disjoint pieces, or may have interior holes. The convention is that clockwise contours [in a left-handed coordinate system as used on the Macintosh] fill positive space, while counter-clockwise contours represent holes. ODPolygon structures are variable size and are always allocated on a heap. They start with a 32-bit count of the number of contours. The contours then follow: each starts with a 32-bit point count and then the points in order. The last point of a contour is of course connected to the first. æKY ODMatrix æC A 3x3 matrix of fixed-point (ODFixed) numbers used to represent a transformation. This is the platform-independent representation of a coordinate transformation. Not all graphics systems support these kind of transformations; some (like QuickDraw) only support simple offsets. See the documentation for the ODTransform class for more details. æKY ODGraphicsSystem æC An enumeration that lists possible graphics systems. Every graphics system supported by OpenDoc, on any platform, should have a unique ODGraphicsSystem ID. These values are used in ODTransforms and ODShapes to tag graphics-system dependent transform or shape data. For instance, on the Macintosh you can feed a Region to an ODShape provided you tag it with kODQuickDraw. æKY ODPlatformShape æC A wrapper for a pointer to graphics-system dependent shape data. The data format is unspecified, and it must be tagged with an ODGraphicsSystem value to identify which graphics system it belongs to. A (ODPlatformShape, ODGraphicsSystem) pair is always sufficient to identify the exact type of the data. æKY ODPlatformTransform æC A wrapper for graphics-system dependent transformation data. The data format is unspecified, and it must be tagged with an ODGraphicsSystem value to identify which graphics system it belongs to. A (ODPlatformTransform, ODGraphicsSystem) pair is always sufficient to identify the exact type of the data. æKY ODGeometryMode æC ODGeometryMode is the geometry mode of an ODShape, which tells whether the shape’s geometric info (its polygonal representation) will be needed in the future. It has three possible values: • kODPreserveGeometry --the default-- means that the shape will preserve its geometric information as long as possible until it is lost by combination with a non-geometric shape. • kODLoseGeometry means that the geometry is not needed and can be discarded to optimize speed. A facet's clipShape will generally have this mode. • kODNeedsGeometry means that the geometry is required. Rather than discard geometry, the shape will throw a kODErrNoShapeGeometry exception if combined with a non-geometric shape. A facet's frameShape and usedShape will have this mode since they are stored persistently in polygonal form. æKY ODHighlight æC An enumeration describing the possible highlight states of an ODFacet. Possible values are: kODNoHighlight, the facet is not highlited; kODFullHighlight, the facet is highlighted in foreground style; kODDimHighlight, the facet is highlighted in background style. æKY ODFramePosition æC An enumeration describing the position of an ODFrame relative to a sibling frame. Possible values are: kODFrameBehind, kODFrameInFront. æKY ODInfoType æC The type of the partInfo data stored in an ODFrame or ODFacet. This is an opaque type. The part editor should cast the partInfo data to and from its own representation to use the data. æKY Messaging Subsystem Types æKL ODIdleProcPtr ODEventFilterProcPtr ODEventHandlerProcPtr ODCoercionHandler ODDescCoercionHandler ODPtrCoercionHandler ODAccessorProcPtr ODCompareProcPtr ODCountProcPtr ODDisposeTokenProcPtr ODGetErrDescProcPtr ODGetMarkTokenProcPtr ODMarkProcPtr ODAdjustMarksProcPtr ODSpecialHandlerPtr ODTokenInquiryProcPtr ODDescType ODSendMode ODSendPriority ODEventClass ODEventID æC Types used by clients of the Messaging subsystem. Most of the function pointer types correspond to AppleEvent function pointer types, with the addition of an ODPart* parameter. æKY ODIdleProcPtr æC See AppleEvent documentation. æKY ODEventFilterProcPtr æC See AppleEvent documentation. æKY ODEventHandlerProcPtr æC See AppleEvent documentation. æKY ODCoercionHandler æC See AppleEvent documentation. æKY ODDescCoercionHandler æC See AppleEvent documentation. æKY ODPtrCoercionHandler æC See AppleEvent documentation. æKY ODAccessorProcPtr æC See AppleEvent documentation. æKY ODCompareProcPtr æC See AppleEvent documentation. æKY ODCountProcPtr æC See AppleEvent documentation. æKY ODDisposeTokenProcPtr æC See AppleEvent documentation. æKY ODGetErrDescProcPtr æC See AppleEvent documentation. æKY ODGetMarkTokenProcPtr æC See AppleEvent documentation. æKY ODMarkProcPtr æC See AppleEvent documentation. æKY ODAdjustMarksProcPtr æC See AppleEvent documentation. æKY ODSpecialHandlerPtr æC See AppleEvent documentation. æKY ODTokenInquiryProcPtr æC Pointer to a function that returns an ODPart* if the given token refers to a part, or kODNULL otherwise. æKY ODDescType æC Same as AEDescType æKY ODSendMode æC Same as AESendMode. æKY ODSendPriority æC Same as AESendPriority. æKY ODEventClass æC Same as AEEventClass. æKY ODEventID æC Same as AEEventID. æKY Storage System Types æKL ODDocumentID ODDocumentName ODDraftID ODDraftName ODObjectType æKY ODDocumentID æC ID used to retrieve a Document. æKY ODDocumentName æC Name associated with a Document æKY ODDraftID æC Identifier for a Draft. æKY ODDraftName æC Name associated with a Draft. æKY ODObjectType æC The type of persistent object which a storageUnit represents. æKY UI Subsystem Types æKL ODFocusType ODPlatformWindow ODEventType ODEventData ODIdleFrequency ODPlatformMenu ODMenuID ODMenuItemID ODCommandID ODPlatformMenuBar ODDoneState ODActionData ODEventInfo æC Types used in the interfaces of the UI subsystem. æKY ODFocusType æC An ISO string. Can be tokenized using ODSession::Tokenize(). Arbitrator methods used tokenized form. æKY ODPlatformWindow æC A platform-specific structure representing a window. On the Macintosh, a WindowPtr. æKY ODEventType æC An unsigned short. Used in the "what" field of a Macintosh event record. æKY ODEventData æC A platform-specific structure representing an event. On the Macintosh, a pointer to a Macintosh event record. æKY ODIdleFrequency æC An unsigned long. The number of ticks (60ths of a second) between idles. æKY ODPlatformMenu æC A platform-specific structure representing a menu. On the Macintosh, a MenuHandle. æKY ODMenuID æC The ID of a menu. On the Macintosh, a signed short. æKY ODMenuItemID æC The ID of a menu item. On the Macintosh, a signed short. æKY ODCommandID æC A signed long. Used for Command IDs associated with menu/item combinations. æKY ODPlatformMenuBar æC A platform-specific structure representing a menu bar. A Handle, on the Macintosh. æKY ODDoneState æC Type of value passed to Part::DisposeActionState(). Possible values: kODDone or kODRedone if the action was on the Undo stack. kODUndone if the action was on the Redo stack. æKY ODActionData æC Action data for Undo/Redo. Defined to be an ODPtr. æKY ODEventInfo æC Additional information passed to ODPart::HandleEvent. Contains four fields: embeddedFrame, embeddedFacet, where, and propagated. The embeddedFrame and embeddedFacet are filled in for events like kODEvtMouseDownInEmbedded which are sent to the containing part, but refer to an embedded frame. The "where" field contains an ODPoint in local (frame) coordinates. The propagated field is set if the containing part has set the propagateEvents flag of an embedded frame, and that embedded frame has not handled an event, which the dispatcher has then passed to the container. æKY ODUndoHelp ODUndo Undo æKL ODUndo::ODUndo ODUndo::~ODUndo ODUndo::AbortCurrentTransaction ODUndo::AddActionToHistory ODUndo::ClearActionHistory ODUndo::ClearRedoHistory ODUndo::InitUndo ODUndo::MarkActionHistory ODUndo::PeekRedoHistory ODUndo::PeekUndoHistory ODUndo::Purge ODUndo::Redo ODUndo::Undo ODUndo::fRedoStack ODUndo::fUndoStack æC Basic Class Documentation ODUndo is used to store command history. ODUndo is a derived class of ODObject. ODUndo is largely platform-independent. If per-document undo is supported, ODUndo is closely tied to ODDraft. Each draft should contain at most one ODUndo object. Theory of Operation ODUndo is a session-wide object used to store command history. The OpenDoc session object creates an ODUndo object. Parts and the OpenDoc shell access ODUndo through ODSession. If thread safety is a concern, the part should acquire the undo focus fromODArbitrator first. As soon as the part is done with the ODUndo object, it should reliquish the undo focus at once. Conceptually, ODUndo object contains two stacks -- the Undo Stack and the Redo Stack. When an action is done, the action data provided by the part is put on the Undo Stack. When an action needs to be "undone", the action data is popped from the Undo stack onto the Redo stack. At the same time, the part is also notified so that it can undo its previous action using the stored action data. When an undone action needs to be redone, the action data is popped from the Redo Stack back to the Undo Stack. The part is also notified so that it can redo the undone action. The Undo Stack and Redo Stack can be cleared upon request. When clearing is to be done, ODUndo asks each part to dispose of its action data stored in the Stacks. The order of disposal is done from older actions to newer actions. There are times when a subhistory is required. For example, one may need a new action context when entering a modal state e.g, a modal dialog. ODUndo allows "marks" to be placed on the Stacks. If a mark is placed on a Stack, the Stack may only be cleared to the mark. In our example, when the modal dialog exits, any actions done within the context of the dialog are disposed of. However, all the actions done before the modal dialog are preserved in the Stacks. ODUndo object also allows callers to peek at the top of the Undo Stack and the Redo Stack. The application shell can then peek to find out the action labels and use the labels for menu items. Invariants Maintained by Class ODUndo must contain two stacks (an undo stack and a redo stack) at all times. æKY ODUndo::ODUndo Undo::ODUndo Undo->ODUndo æT Class Method æD ODUndo(); æC Protection Private. Meant to called from ODSession Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Constructs the Undo object. Inputs None Outputs None Exceptions Signalled None. Pre conditions None. Post conditions Object is allocated and in a safe state. æKY ODUndo::~ODUndo Undo::~ODUndo Undo->~ODUndo æT Class Method æD ~ODUndo(); æC Protection Private. Meant to called from ODSession Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Frees the memory allocated by this Inputs None Outputs None Exceptions Signalled None. Pre conditions None. Post conditions Object is destroyed. æKY ODUndo::AbortCurrentTransaction Undo::AbortCurrentTransaction Undo->AbortCurrentTransaction æT Class Method æD æC Protection Public. Override policy Derived class can override. Derived class must call base class behavior, during derived class behavior. Basic operation This method removes all single actions up to the last begin action and removes the begin action as well. If there were a nested transaction in the current transaction, it would be entirely removed. The UndoAction methods of the parts are called so that the parts can restore themselves to their state before the transaction began. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions A transaction must have been started and not finished, i.e., a part must have added a begin action to the history and no end action has yet been added to the history. Post conditions The current transaction (and any nested transactions) will be removed from the action history. æKY ODUndo::AddActionToHistory Undo::AddActionToHistory Undo->AddActionToHistory æT Class Method æD void AddActionToHistory( ODPart* whichPart, ODActionData actionData, ODActionType actionType, ODName* actionLabel); æC Protection Public. Parts can call, but shell apps must not call. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation This function pushes actionData together with its associated part onto the Undo Stack. Inputs whichPart the part that performed the action actionData Data provided the part with which it can restore itself to the pre-action state actionType kSingleAction means it is a single action. kBeginAction means the first of a two-part action.kEndAction means the second of a two-part action. undoActionLabel A user-visible label for the undo command including the word "Undo". redoActionLabel A user-visible label for the redo command including the word "Redo". Outputs None Exceptions Signalled kODErrCannotAddAction Currently already doing an undo or redo; trying to add a nested begin action. kODErrOutOfMemory Initialization of ODUndo object failed; Couldn't allocate memory for action info. Pre conditions Undo Stack has been created. Post conditions whichPart and actionData are on the top of the Undo Stack. æKY ODUndo::ClearActionHistory Undo::ClearActionHistory Undo->ClearActionHistory æT Class Method æD void ClearActionHistory( ODRespectMarksChoices respectMarks); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation This function clears the Stacks down to the last marks if respectMarks is kODRespectMarks. Otherwise, it clears the Stacks. If kODRespectMarks is true, the previous marks are cleared. Inputs respectMarks respect or don't respect marks. Outputs None Exceptions Signalled None. Pre conditions Undo Stack and Redo Stack have been created. Post conditions Undo Stack and Redo Stack should be empty or cleared to the marks depending on respectMarks. æKY ODUndo::ClearRedoHistory Undo::ClearRedoHistory Undo->ClearRedoHistory æT Class Method æD void ClearRedoHistory(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation This function clears the Redo history. Marks are always respected. Inputs None Outputs None Exceptions Signalled None. Pre conditions Redo Stack has been created. Post conditions Redo Stack should be empty. æKY ODUndo::InitUndo Undo::InitUndo Undo->InitUndo æT Class Method æD void InitUndo(); æC Protection Private. Meant to be called from ODSession only. Override policy Derived class cannot override. Derived class cannot call base class behavior, before derived class behavior. Basic operation Performs initialization which can fail. Inputs None Outputs None Exceptions Signalled kODErrOutOfMemory Not enough memory to allocated undo and redo stacks and shared memory. Others… AppleEvent and ASLM errors also possible. Pre conditions None. Post conditions The object is fully initialized. æKY ODUndo::MarkActionHistory Undo::MarkActionHistory Undo->MarkActionHistory æT Class Method æD void MarkActionHistory(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation This function places a mark on top of the Undo Stack and the Redo Stack. The marks are used to indicate the beginning of a subhistory. When ODUndo::ClearActionHistory is done, the caller has the choice to clear the whole Stacks or to clear only down to these marks. This can be used when entering a modal state like a modal dialog, to give the effect of creating a new context. Inputs None Outputs None Exceptions Signalled kODErrCannotMarkAction ODUndo was never initialized properly. Pre conditions Both Undo Stack and Redo Stack are created. Post conditions Marks are on top of both Undo Stack and Redo Stack. æKY ODUndo::PeekRedoHistory Undo::PeekRedoHistory Undo->PeekRedoHistory æT Class Method æD ODBoolean PeekRedoHistory( ODPart** part, ODActionData* actionData, ODActionType* actionType, ODName** actionLabel); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation This function returns information about the redoable action on the top of the Redo Stack. If the function returns kODTrue, there was an action to return, else no action was available and the information in the parameters is invalid. This function repects marks. Inputs None Outputs part Part which performed the redoable action actionData Action data provided by part actionType kSingleAction, kBeginAction, kEndAction actionLabel User visible redo string. A pointer to internal storage is passed back so care should be taken to make a copy. Return Returns whether there was anything on the stack. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODUndo::PeekUndoHistory Undo::PeekUndoHistory Undo->PeekUndoHistory æT Class Method æD ODBoolean PeekUndoHistory( ODPart** part, ODActionData* actionData, ODActionType* actionType, ODName** actionLabel); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation This function returns information about the undoable action on the top of the Undo Stack. If the function returns kODTrue, there was an action to return, else no action was available and the information in the parameters is invalid. This function repects marks. Inputs None Outputs part Part which performed the undoable action actionData Action data provided by part actionType kSingleAction, kBeginAction, kEndAction actionLabel User visible undo string. A pointer to internal storage is returned so care should be taken to make a copy. Return Returns whether there was anything on the stack. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODUndo::Purge Undo::Purge Undo->Purge æT Class Method æD ODSize Purge( ODSize size); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Frees up some memory, if possible. Inputs size The amount of memory requested Outputs <return> The amount of memory actually freed. Exceptions Signalled None. Pre conditions None. Post conditions Some memory may be freed. æKY ODUndo::Redo Undo::Redo Undo->Redo æT Class Method æD void Redo(); æC Protection Public. Usually the container is responsible for calling this. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation This function redoes the last undone action in the Redo history. Inputs None Outputs None Exceptions Signalled Others… AppleEvent errors and any error returned from the part. kODErrEmptyStack Redo stack is empty; Undo object was never initialized. Pre conditions Both Undo Stack and Redo Stack are created. Redo Stack is not empty. Post conditions What was on top of the Redo Stack is now on top of the Undo Stack. æKY ODUndo::Undo Undo::Undo Undo->Undo æT Class Method æD void Undo(); æC Protection Public. Usually only called by the container app or document shell. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation This function undoes the last action in the Undo history. Inputs None Outputs None Exceptions Signalled Other… AppleEvent errors or any errors returned by the part. kODErrEmptyStack Undo stack is empty; Undo object was never initialized. Pre conditions Both Undo Stack and Redo Stack are created. Undo Stack is not empty. Post conditions What was on top of the Undo Stack is now on top of the Redo Stack. æKY ODUndo::fRedoStack Undo::fRedoStack æT Class Field æD ODStack* fRedoStack; æC Persistent form None. æKY ODUndo::fUndoStack Undo::fUndoStack æT Class Field æD ODStack* fUndoStack; æC æKY ODValueIteratorHelp ODValueIterator ValueIterator æKL ODValueIterator::~ODValueIterator ODValueIterator:: ODValueIterator::First ODValueIterator::InitValueIterator ODValueIterator::IsNotComplete ODValueIterator::Next ODValueIterator::fNameSpace ODValueIterator::fStrHashIterator æC Basic Class Documentation This class is an iterator for use with the ODValueNameSpace class. It has no superclass. The platform vendor will implement. Theory of Operation This iterator follows the standard semantics of OpenDoc iterators except that two values are returned in pointer parameters: the key and the value. This class is a friend of ODValueNameSpace. It's implementation depends heavily on the implementation of the ODValueNameSpace class. Invariants Maintained by Class It is only meant to be used in the context of a for statement. Any other use is not guaranteed to be correct. æKY ODValueIterator::~ODValueIterator ValueIterator::~ODValueIterator ValueIterator->~ODValueIterator æT Class Method æD ~ODValueIterator(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Deletes private storage. Inputs None. Outputs None Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODValueIterator::None. ValueIterator::None. ValueIterator->None. æT Class Method æD æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation None. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODValueIterator::First ValueIterator::First ValueIterator->First æT Class Method æD void First( ODISOStr* key, ODByteArray* value); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Return the first key/value pair. If there are no entries in the table, the values returned are garbage and the next call to IsNotComplete will return false. Note that the ODISOStr returned is a copy. The client must dispose of it. Inputs key a pointer to the key to be returned. value a pointer to the ODByteArray containing the value to be returned. Outputs key the key placed in the storage pointed to by key. value the value placed in the storage pointed to by value . Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODValueIterator::InitValueIterator ValueIterator::InitValueIterator ValueIterator->InitValueIterator æT Class Method æD InitValueIterator( ODValueNameSpace* nameSpace); æC Protection Private. should only be called by ODValueNameSpace Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Initialize the private member variables. Inputs nameSpace The ODValueNameSpace over which to iterate. Outputs None Exceptions Signalled None. Pre conditions A valid ODValueNameSpace must exist. Post conditions None. æKY ODValueIterator::IsNotComplete ValueIterator::IsNotComplete ValueIterator->IsNotComplete æT Class Method æD ODBoolean IsNotComplete(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Return whether we have tried to go beyond the end of the ODValueNameSpace entries. Inputs None Outputs <return> kODFalse if we have tried to get an entry that was beyond the end of the table, kODTrue otherwise. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODValueIterator::Next ValueIterator::Next ValueIterator->Next æT Class Method æD void Next( ODISOStr* key, ODByteArray* value); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Return the next key/value pair. If there are no more entries in the table, the values returned are garbage and the next call to IsNotComplete will return false. Note that the ODISOStr returned is a copy. The client must dispose of it. Inputs key a pointer to the key to be returned. value a pointer to the ODByteArray containing the value to be returned. Outputs key the key placed in the storage pointed to by key. value the value placed in the storage pointed to by value . Exceptions Signalled None. Pre conditions First must be have been called! Post conditions None. æKY ODValueIterator::fNameSpace ValueIterator::fNameSpace æT Class Field æD ODValueNameSpace* fNameSpace; æC Persistent form None. æKY ODValueIterator::fStrHashIterator ValueIterator::fStrHashIterator æT Class Field æD ODStringHashTableIterator* fStrHashIterator; æC Persistent form None. æKY ODValueNameSpaceHelp ODValueNameSpace ValueNameSpace æKL ODValueNameSpace::ODValueNameSpace ODValueNameSpace::~ODValueNameSpace ODValueNameSpace::CreateIterator ODValueNameSpace::GetEntry ODValueNameSpace::InitValueNameSpace ODValueNameSpace::ReadFromFile ODValueNameSpace::ReadFromStorage ODValueNameSpace::Register ODValueNameSpace::Unregister ODValueNameSpace::WriteToFile ODValueNameSpace::WriteToStorage æC Basic Class Documentation This class represents a value name space. Objects of this class are created by member functions of the ODNameSpaceManager class. The platform vendor will implement. ODValueNameSpace is a subclass of ODNameSpace. Theory of Operation This class allows registering ODByteArrays witha keys of type ODISOStr. Values are hashed for quick lookup. Invariants Maintained by Class There is always a valid hash table instantiated to hold the key/value pairs. It may be empty. æKY ODValueNameSpace::ODValueNameSpace ValueNameSpace::ODValueNameSpace ValueNameSpace->ODValueNameSpace æT Class Method æD ODValueNameSpace(); æC Protection Private. Only called by ODNameSpaceManager::CreateNameSpace. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Initialize an ODNameSpace class Inputs None. Outputs None Exceptions Signalled None. Pre conditions None. Post conditions A new ODNameSpace class will be created. æKY ODValueNameSpace::~ODValueNameSpace ValueNameSpace::~ODValueNameSpace ValueNameSpace->~ODValueNameSpace æT Class Method æD virtual ~ODValueNameSpace(); æC Protection Private. Called only by ODNameSpaceManager::DeleteNameSpace. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Destroys the ODNameSpace object and any associated storage. Inputs None Outputs None Exceptions Signalled None. Pre conditions None. Post conditions Object all gone. æKY ODValueNameSpace::CreateIterator ValueNameSpace::CreateIterator ValueNameSpace->CreateIterator æT Class Method æD ODValueIterator CreateIterator(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation None. Inputs None. Outputs ODValueIterator An iterator for this name space. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODValueNameSpace::GetEntry ValueNameSpace::GetEntry ValueNameSpace->GetEntry æT Class Method æD ODBoolean GetEntry( ODISOStr key, ODByteArray* value); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation None. Inputs key An ODISOStr hash key used to look up a value in the name space. value The ODByteArray containing the value returned from the lookup. Outputs Return ODBoolean indicating if an entry for this key is found or not. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODValueNameSpace::InitValueNameSpace ValueNameSpace::InitValueNameSpace ValueNameSpace->InitValueNameSpace æT Class Method æD void InitValueNameSpace( ODNameSpaceManager* mgr, ODNameSpace* parent, ODULong numExpectedEntries, ODISOStr name); æC Protection Private. Should only be called by ODNameSpaceManager Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Initializes the object. Inputs mgr The NameSpaceManager object that this NameSpace belongs to. parent An ODNameSpace to search if a GetValue fails in this one. numExpectedEntries The number of expected entries. name the name to give this ODNameSpace. Outputs None. Exceptions Signalled kODErrOutOfMemory Out of memory. Pre conditions None. Post conditions The object will be initialized. æKY ODValueNameSpace::ReadFromFile ValueNameSpace::ReadFromFile ValueNameSpace->ReadFromFile æT Class Method æD void ReadFromFile( PlatformFile file); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Read the name space from the file into this ODNameSpace. Assumes that the data was written with WriteToFile. If the name of the name space doesn not match that that was stored in the stream, an exception will be thrown. It's assumed that the file's cursor has been placed at the beginning of the data stream. Inputs file The file from which to read the data. Outputs None. Exceptions Signalled kODErrInvalidName The stored name does not match that of the name space. Pre conditions Data must have been streamed with WriteToFile. Post conditions The name space will contain entries corresponding to the streamed data. æKY ODValueNameSpace::ReadFromStorage ValueNameSpace::ReadFromStorage ValueNameSpace->ReadFromStorage æT Class Method æD void ReadFromStorage( ODStorageUnitView* view); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Read the name space from storage into this ODNameSpace. Assumes that the data was written with WriteToStorage. If the name of the name space doesn not match that that was stored in the stream, an exception will be thrown. Inputs view The storage unit from which to read the data. Outputs None. Exceptions Signalled kODErrInvalidName The stored name does not match that of the name space. Pre conditions Data must have been streamed with WriteToStorage. Post conditions The name space will contain entries corresponding to the streamed data. æKY ODValueNameSpace::Register ValueNameSpace::Register ValueNameSpace->Register æT Class Method æD void Register( ODISOStr key, ODByteArray value); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation None. Inputs key ODISOStr key for the entry to be added. value ODByteArray containing the value to be added. Outputs None. Exceptions Signalled None. Pre conditions ODByteArray is valid. Post conditions Memory is allocated and an entry is added tothe name space. æKY ODValueNameSpace::Unregister ValueNameSpace::Unregister ValueNameSpace->Unregister æT Class Method æD virtual void Unregister( ODISOStr key); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Removes the given entry from the ODNameSpace. Inputs key Key for the entry to be removed. Outputs None. Exceptions Signalled None. Pre conditions The given entry must have been registered. No error is signalled, however, if the key does not already exist. Post conditions The given entry will be removed. The memory allocated for the value will be disposed of. æKY ODValueNameSpace::WriteToFile ValueNameSpace::WriteToFile ValueNameSpace->WriteToFile æT Class Method æD void WriteToFile( PlatformFile file); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Write the name space out as a stream to the file. This stream may be read back in by ReadFromFile. Inputs file The file to which to write the data. Outputs None. Exceptions Signalled misc File system errors and/or storage errors. Pre conditions None. Post conditions Data will be written out to the given file. æKY ODValueNameSpace::WriteToStorage ValueNameSpace::WriteToStorage ValueNameSpace->WriteToStorage æT Class Method æD void WriteToStorage( ODStorageUnitView* view); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Write the name space out as a stream to the storage unit view. This stream may be read back in by ReadFromStorage. Inputs view The storage unit to which to write the data. Outputs None. Exceptions Signalled misc File system errors and/or storage errors. Pre conditions None. Post conditions Data will be written out to storage. æKY ODWindowHelp ODWindow Window æKL ODWindow::ODWindow ODWindow::~ODWindow ODWindow::Activate ODWindow::AdjustWindowShape ODWindow::Close ODWindow::CloseAndRemove ODWindow::Deactivate ODWindow::GetFacetUnderPoint ODWindow::GetID ODWindow::GetPlatformWindow ODWindow::GetRootFacet ODWindow::GetRootFrame ODWindow::GetSourceFrame ODWindow::Hide ODWindow::InitWindow ODWindow::InitWindowFromStorage ODWindow::IsActive ODWindow::IsFloating ODWindow::IsResizable ODWindow::IsRootWindow ODWindow::IsShown ODWindow::Open ODWindow::Purge ODWindow::Select ODWindow::SetShouldDispose ODWindow::SetShouldSave ODWindow::SetShouldShowLinks ODWindow::SetSourceFrame ODWindow::ShouldDispose ODWindow::ShouldSave ODWindow::ShouldShowLinks ODWindow::Show ODWindow::Update ODWindow::fArbitrator; ODWindow::fDraft ODWindow::fID ODWindow::fIsAOCEMailerAware ODWindow::fIsFloating ODWindow::fIsResizable ODWindow::fIsRootWindow ODWindow::fMailerHelper ODWindow::fPlatformWindow ODWindow::fRootFacet ODWindow::fRootFrame ODWindow::fRootPart ODWindow::fSession ODWindow::fShouldSave ODWindow::fShouldShowLinks ODWindow::fSourceFrame ODWindow::fStorageUnit ODWindow::fWasVisible æC Basic Class Documentation ODWindow is a subclass of ODRefCntObject. Related classes are ODWindowState and ODWindowIterator , ODFrame and ODFacet. ODWindow is platform-specific. Theory of Operation Every window must be associated with an OpenDoc ODWindow object so that the part belonging to the root frame of the window, and embedded parts, can receive events from the OpenDoc event dispatcher. Each ODWindow contains a pointer to a platform-specific window structure. The facilites of the platform are used to actually create new windows. These are added to the window state using ODWindowState::CreateWindow() which creates and returns an ODWindow instance. Part editors can send messages to these ODWindow instances, and obtain the platform window to make platform-specific calls. Each window has a root Frame and a root Facet. Invariants Maintained by Class An ODWindow contains a reference to a platform-specific window. An ODWindow always has a root frame and facet. Various other properties, such as the window type (whether it has a close box etc.) are invariant. Other Persistent Properties kODPropWindowRect kODPropWindowTitle kODPropWindowProcID kODPropWindowIsVisible kODPropWindowHasCloseBox kODPropWindowHasZoomBox kODPropWindowIsResizable kODPropWindowIsRootWindow kODPropWindowIsFloating kODPropWindowHasMailer kODPropWindowIsMailerAware kODPropWindowRefCon kODPropRootFrame kODPropSourceFrame kODPropShouldShowLinks æKY ODWindow::ODWindow Window::ODWindow Window->ODWindow æT Class Method æD ODWindow(); æC Protection Public. Private to UI subsystem. Part editors call ODWindowState::CreateWindow(). Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Constructs the window object. InitWindow must also be called. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions A constructed window object, which can be safely deleted, but can not be used until InitWindow has been called. æKY ODWindow::~ODWindow Window::~ODWindow Window->~ODWindow æT Class Method æD ~ODWindow(); æC Protection Public. Part Editors call ODWindow::CloseAndRemove Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Frees the memory used by this instance. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions The memory used by this instance is freed, and the instance is no longer usable. æKY ODWindow::Activate Window::Activate Window->Activate æT Class Method æD void Activate(); æC Protection Public. Private to UI subsystem. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Sends an activate event to all the running parts in this window. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions All the parts currently running in the window have received activate events. æKY ODWindow::AdjustWindowShape Window::AdjustWindowShape Window->AdjustWindowShape æT Class Method æD void AdjustWindowShape(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Reshapes the root frame to match the window size. Should be called by parts if they resize a window programmatically Inputs None. Outputs None. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions The root frame matches the window shape. æKY ODWindow::Close Window::Close Window->Close æT Class Method æD void Close(); æC Protection Public. Called by the shell and window state. Parts typically call CloseAndRemove. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Closes this window. The window is hidden, removed from the window state, and the root frame is closed. The facet hierarchy is deleted. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions The window is closed, and no longer usable. æKY ODWindow::CloseAndRemove Window::CloseAndRemove Window->CloseAndRemove æT Class Method æD void CloseAndRemove(); æC Protection Public. Called by parts to remove auxiliary windows like palettes, which are not stored persistently. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Closes this window. The window is hidden, removed from the window state, and the root frame is removed from the draft. The facet hierarchy is deleted. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions The window is closed, and no longer usable. æKY ODWindow::Deactivate Window::Deactivate Window->Deactivate æT Class Method æD void Deactivate(); æC Protection Public. Not called by parts. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Deactivates all the running parts in this window. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions All the parts currently running in the window received deactivate events. æKY ODWindow::GetFacetUnderPoint Window::GetFacetUnderPoint Window->GetFacetUnderPoint æT Class Method æD ODFrame* GetFacetUnderPoint( ODPoint aPoint); æC Protection Public. Part Editors typically won't call this method. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the facet under the given point. If several nested facets are under the point, the innermost one is returned. If multiple overlapping frames are under the point, the unobscured(i.e. frontmost) one is returned. The "frozen" and "selected" properties of frames and facets are respected. Inputs aPoint A point in window coordinates. Outputs <return> The facet under the point. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions No effect on this instance. æKY ODWindow::GetID Window::GetID Window->GetID æT Class Method æD ODID GetID(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the ID of the window. The WindowState creates IDs for windows. A window pointer can be obtained by calling ODWindowState::getWindow. In this way, parts can detect that a window has been destroyed. Inputs None. Outputs <return> The ID of this window. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions No effect on this instance. æKY ODWindow::GetPlatformWindow Window::GetPlatformWindow Window->GetPlatformWindow æT Class Method æD ODPlatformWindow GetPlatformWindow(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the platform-specific window data structure Inputs None. Outputs <return> The platform-specific window stored in fPlatformWindow. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions No effect on this instance. æKY ODWindow::GetRootFacet Window::GetRootFacet Window->GetRootFacet æT Class Method æD ODFacet* GetRootFacet(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the root facet of the window. The root facet is created when the window is Open()ed, even though it may not yet be shown. Inputs None. Outputs <return> The root facet of the window. Exceptions Signalled None. Pre conditions A valid initialized window instance, whose Open() method has been called. Post conditions No effect on this instance. æKY ODWindow::GetRootFrame Window::GetRootFrame Window->GetRootFrame æT Class Method æD ODFrame* GetRootFrame(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the root frame of the window. Inputs None. Outputs <return> The root frame of the window. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions No effect on this instance. æKY ODWindow::GetSourceFrame Window::GetSourceFrame Window->GetSourceFrame æT Class Method æD ODFrame* GetSourceFrame(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the frame from which this window was opened. May be kODNULL. Inputs None. Outputs <return> The frame from which this window was opened, or kODNULL Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions No effect on this instance. æKY ODWindow::Hide Window::Hide Window->Hide æT Class Method æD void Hide(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Makes the window invisible. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions The window is hidden. æKY ODWindow::InitWindow Window::InitWindow Window->InitWindow æT Class Method æD InitWindow( ODPlatformWindow platformWindow, ODType frameType, ODBoolean isRootWindow, ODBoolean isResizable, ODBoolean isFloating, ODBoolean shouldSave, ODPart* rootPart, ODTypeToken viewType, ODTypeToken presentation, ODFrame* sourceFrame); æC Protection Public. Private to UI subsystem. Part editors call ODWindowState::CreateWindow(). Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Initializes the window object. Stores the supplied attributes, and creates a root frame. The Open() method must still be called. Inputs platformWindow A pointer to a platform-specific window structure isRootWindow Does this window "keep the document open". kODFalse for dialog and other auxiliary windows. isResizable kODTrue, if the window is resizable by the user. isFloating kODTrue if the window shouldalways float above others. shouldSave kODTrue if the window state should save this window persistently in the document. rootPart The part associated with the root frame of the window. viewType The view type for the root frame of the window. See ODFrame. presentation The presentation type for the root frame. See ODFrame. sourceFrame The frame from which this window was opened. Can be kODNull. frameType The type which should be used to create the root frame of the window. Outputs None Exceptions Signalled None. Constructors must not fail. Pre conditions A constructed instance. Post conditions An initialized instance. Open() must still be called. æKY ODWindow::InitWindowFromStorage Window::InitWindowFromStorage Window->InitWindowFromStorage æT Class Method æD InitWindowFromStorage( ODStorageUnit* su); æC Protection Public. Private to UI subsystem. Part editors call ODWindowState::CreateWindow(), and the WindowState creates windows when documents are opened. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Initializes the window object from a storage unit. Inputs su A storage unit supplied by the window state. Outputs None. Exceptions Signalled None. Pre conditions A constructed instance. Post conditions An initialized instance. Open() must still be called. æKY ODWindow::IsActive Window::IsActive Window->IsActive æT Class Method æD ODBoolean IsActive(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns kODTrue if this window is a floating window, or the frontmost non-floating window. Inputs None. Outputs <return> kODTrue, if this is an active window. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions No effect on this instance. æKY ODWindow::IsFloating Window::IsFloating Window->IsFloating æT Class Method æD ODBoolean IsFloating(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Returns kODTrue if the window is a floating window, kODFalse otherwise. Inputs None. Outputs <return> kODTrue if the window is a floating window, kODFalse otherwise Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions No effect on this instance. æKY ODWindow::IsResizable Window::IsResizable Window->IsResizable æT Class Method æD ODBoolean IsResizable(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Returns kODTrue if the window is resizable by users, kODFalse otherwise. Inputs None. Outputs <return> kODTrue if the window is resizable, kODFalse otherwise Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions No effect on this instance. æKY ODWindow::IsRootWindow Window::IsRootWindow Window->IsRootWindow æT Class Method æD ODBoolean IsRootWindow(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Returns kODTrue if the window is a root window, kODFalse otherwise. Inputs None. Outputs <return> kODTrue if the window is a root window, kODFalse otherwise Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions No effect on this instance. æKY ODWindow::IsShown Window::IsShown Window->IsShown æT Class Method æD ODBoolean IsShown(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Returns kODTrue if the window is currently shown, kODFalse otherwise. Inputs None. Outputs <return> kODTrue if the window is currently shown, kODFalse otherwise Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions No effect on this instance. æKY ODWindow::Open Window::Open Window->Open æT Class Method æD void Open(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Creates a facet hierarchy in this window. Does not make the window visible or change window ordering. Show() and Select() must be called for those operations. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions The window and facet structure is build, and the window can be shown using Show(). æKY ODWindow::Purge Window::Purge Window->Purge æT Class Method æD ODSize Purge( ODSize size); æC Protection Public. Called by OpenDoc. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Frees up some memory, by deleting cached values which can be recomputed or restored from persistent storage. Inputs size The amount of memory requested. Outputs <return> The amount of memory freed. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions Some memory has been freed up. æKY ODWindow::Select Window::Select Window->Select æT Class Method æD void Select(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Brings the window to the front, making it an active window. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions The window is frontmost (except for floating windows), and active. æKY ODWindow::SetShouldDispose Window::SetShouldDispose Window->SetShouldDispose æT Class Method æD void SetShouldDispose( ODBoolean shouldDispose); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Changes the value of the "shouldDispose" property, which determined if the platform window is disposed when the window is deleted. Inputs shouldDispose kODTrue if the platform window should be disposed when the window is deleted. Outputs None. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions fShouldDispose is updated. æKY ODWindow::SetShouldSave Window::SetShouldSave Window->SetShouldSave æT Class Method æD void SetShouldSave( ODBoolean shouldSave); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Changes the value of the "shouldSave" property Inputs shouldSave kODTrue if the window should be saved in the draft. Outputs None. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions fShouldSave is updated. æKY ODWindow::SetShouldShowLinks Window::SetShouldShowLinks Window->SetShouldShowLinks æT Class Method æD void SetShouldShowLinks( ODBoolean shouldShowLinks); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Changes the value of the "shouldShowLinks" property Inputs shouldShowLinks kODTrue if links should be shown, kODFalse otherwise. Outputs None. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions fShouldShowLinks is updated. æKY ODWindow::SetSourceFrame Window::SetSourceFrame Window->SetSourceFrame æT Class Method æD void SetSourceFrame( in ODFrame frame); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Sets the source frame of this window. Can be used (somewhat rarely) to associate a window with a different source frame than the one it was created from. Inputs frame The new source frame Outputs None. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions Internal reference to source frame is updated æKY ODWindow::ShouldDispose Window::ShouldDispose Window->ShouldDispose æT Class Method æD ODBoolean ShouldDispose(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior. Basic operation Returns kODTrue if the platform window should be disposed when the window is deleted. Inputs None. Outputs <return> kODTrue if the platform window will be disposed when the window is deleted. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions No effect on this instance. æKY ODWindow::ShouldSave Window::ShouldSave Window->ShouldSave æT Class Method æD ODBoolean ShouldSave(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Returns kODTrue if the window is saved in the draft, kODFalse otherwise. Inputs None. Outputs <return> kODTrue if the window is saved in the draft, kODFalse otherwise Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions No effect on this instance. æKY ODWindow::ShouldShowLinks Window::ShouldShowLinks Window->ShouldShowLinks æT Class Method æD ODBoolean ShouldShowLinks(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Returns kODTrue if the user has requested that links be highlighted in the window. Inputs None. Outputs <return> kODTrue if links should be shown, kODFalse otherwise Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions No effect on this instance. æKY ODWindow::Show Window::Show Window->Show æT Class Method æD void Show(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Makes the window visible. Does not change the ordering of windows. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions The window is visible. æKY ODWindow::Update Window::Update Window->Update æT Class Method æD void Update(); æC Protection Public. Called by the Dispatcher, or by parts. Override policy Derived class can override. Derived class can call base class behavior. Basic operation Parts can call this method to force updating when it won't happen automatically, for instance when the mouse button is down. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODWindow::fArbitrator; Window::fArbitrator; æT Class Field æD ODArbitrator fArbitrator; æC æKY ODWindow::fDraft Window::fDraft æT Class Field æD ODDraft* fDraft; æC æKY ODWindow::fID Window::fID æT Class Field æD ODID fID; æC æKY ODWindow::fIsAOCEMailerAware Window::fIsAOCEMailerAware æT Class Field æD ODBoolean fIsAOCEMailerAware; æC æKY ODWindow::fIsFloating Window::fIsFloating æT Class Field æD ODBoolean fIsFloating; æC æKY ODWindow::fIsResizable Window::fIsResizable æT Class Field æD ODBoolean fIsResizable; æC æKY ODWindow::fIsRootWindow Window::fIsRootWindow æT Class Field æD ODBoolean fIsRootWindow; æC æKY ODWindow::fMailerHelper Window::fMailerHelper æT Class Field æD AOCEObje* fMailerHelper; æC æKY ODWindow::fPlatformWindow Window::fPlatformWindow æT Class Field æD ODPlatformWindow fPlatformWindow; æC æKY ODWindow::fRootFacet Window::fRootFacet æT Class Field æD ODFacet* fRootFacet æC æKY ODWindow::fRootFrame Window::fRootFrame æT Class Field æD ODFrame* fRootFrame; æC æKY ODWindow::fRootPart Window::fRootPart æT Class Field æD ODPart* fRootPart; æC æKY ODWindow::fSession Window::fSession æT Class Field æD ODSession* fSession; æC æKY ODWindow::fShouldSave Window::fShouldSave æT Class Field æD ODBoolean fShouldSave; æC æKY ODWindow::fShouldShowLinks Window::fShouldShowLinks æT Class Field æD ODBoolean fShouldShowLinks; æC æKY ODWindow::fSourceFrame Window::fSourceFrame æT Class Field æD ODFrame* fSourceFrame; æC æKY ODWindow::fStorageUnit Window::fStorageUnit æT Class Field æD ODStorageUnit* fStorageUnit; æC æKY ODWindow::fWasVisible Window::fWasVisible æT Class Field æD ODBoolean fWasVisible; æC æKY ODWindowIteratorHelp ODWindowIterator WindowIterator æKL ODWindowIterator::ODWindowIterator ODWindowIterator::~ODWindowIterator ODWindowIterator::First ODWindowIterator::InitWindowIterator ODWindowIterator::IsNotComplete ODWindowIterator::Last ODWindowIterator::Next ODWindowIterator::Previous ODWindowIterator::fIterator ODWindowIterator::fWindowState æC Basic Class Documentation ODWindowIterator is a companion class of ODWindowState , used to iterate over the windows in the window state. ODWindowIterator has no base class. Related classes are ODWindowState and ODWindow. ODWindowIterator is platform-independent. Theory of Operation ODWindowIterator is a companion class of ODWindowState , used to iterate over the windows in the window state. Given the window state, ODWindowIterator allows the developer to iterate over all the windows in a loop, using the iterator's First(), Next() and IsNotComplete() methods. Note that the window list in the window state is ordered by creation time, not by screen ordering. Invariants Maintained by Class ODWindowIterator maintains a reference to the window state, and to the current window (or to a lower-level iterator). æKY ODWindowIterator::ODWindowIterator WindowIterator::ODWindowIterator WindowIterator->ODWindowIterator æT Class Method æD ODWindowIterator(); æC Protection Public. Parts should call ODWindowState::CreateWindowIterator() Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Constructs the iterator. InitWindowIterator must also be called. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions A properly constructed window iterator. Can be deleted, but InitWindowIterator must be called before use. æKY ODWindowIterator::~ODWindowIterator WindowIterator::~ODWindowIterator WindowIterator->~ODWindowIterator æT Class Method æD ~ODWindowIterator(); æC Protection Public. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Frees the memory allocated by this class. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions A constructed instance. Post conditions The memory used by this instance is freed. æKY ODWindowIterator::First WindowIterator::First WindowIterator->First æT Class Method æD ODWindow* First(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the first window in the window state. Advance iteration with Next(). Not related to front-to-back ordering of windows. Inputs None. Outputs <return> The first window in the window state Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions Current window is advanced. æKY ODWindowIterator::InitWindowIterator WindowIterator::InitWindowIterator WindowIterator->InitWindowIterator æT Class Method æD InitWindowIterator( ODWindowState* windowState); æC Protection Public. Parts call ODWindowState::CreateWindowIterator Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Initializes the iterator. Inputs windowState The window state over which to iterate Outputs None. Exceptions Signalled kODErrInvalidWindowState The specified window state is not valid. Pre conditions A constructed instance. Post conditions A properly initialized window iterator, ready for use. æKY ODWindowIterator::IsNotComplete WindowIterator::IsNotComplete WindowIterator->IsNotComplete æT Class Method æD ODBoolean IsNotComplete(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns kODTrue if there are more windows to iterate over, kODFalse otherwise. Inputs None. Outputs <return> kODTrue, if there are more windows to iterate over. Exceptions Signalled None. Pre conditions A valid initialized instance. First() or Last() has been called. Post conditions Result contains kODTrue if there are more windows to iterate over, kODFalse otherwise. æKY ODWindowIterator::Last WindowIterator::Last WindowIterator->Last æT Class Method æD ODWindow* Last(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the last window in the window state. Advance iteration with Previous(). Inputs None. Outputs <return> The last window in the window state Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions Current window is advanced. æKY ODWindowIterator::Next WindowIterator::Next WindowIterator->Next æT Class Method æD ODWindow* Next(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the next window in the window state. Begin iteration with First(). Inputs None. Outputs <return> The next window in the window state Exceptions Signalled None. Pre conditions First() has been called. Post conditions Current window is advanced. æKY ODWindowIterator::Previous WindowIterator::Previous WindowIterator->Previous æT Class Method æD ODWindow* Previous(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the previous window in the window state. Begin iteration with Last(). Inputs None. Outputs <return> The previous window in the window state Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions Current window is advanced. æKY ODWindowIterator::fIterator WindowIterator::fIterator æT Class Field æD LinkedListIterator* fIterator; æC æKY ODWindowIterator::fWindowState WindowIterator::fWindowState æT Class Field æD ODWindowState* fWindowState; æC æKY ODWindowStateHelp ODWindowState WindowState æKL ODWindowState::ODWindowState ODWindowState::~ODWindowState ODWindowState::AcquireActiveWindow ODWindowState::AcquireBaseMenuBar ODWindowState::AcquireCurrentMenuBar ODWindowState::AcquireFrontFloatingWindow ODWindowState::AcquireFrontRootWindow ODWindowState::AcquireFrontWindow ODWindowState::AcquireODWindow ODWindowState::AcquireWindow ODWindowState::ActivateFrontWindows ODWindowState::AdjustPartMenus ODWindowState::CloseWindows ODWindowState::CopyBaseMenuBar ODWindowState::CreateCanvas ODWindowState::CreateMenuBar ODWindowState::CreateWindowIterator ODWindowState::DeactivateFrontWindows ODWindowState::Externalize ODWindowState::GetRootWindowCount ODWindowState::GetTotalRootWindowCount ODWindowState::GetWindowCount ODWindowState::InitWindowState ODWindowState::Internalize ODWindowState::IsODWindow ODWindowState::OpenWindows ODWindowState::Purge ODWindowState::RegisterWindow ODWindowState::RegisterWindowForFrame ODWindowState::SetBaseMenuBar ODWindowState::SetCurrentMenuBar ODWindowState::SetDefaultWindowTitles ODWindowState::fBaseMenuBar ODWindowState::fCurrentMenuBar ODWindowState::fNextID ODWindowState::fSession ODWindowState::fWindowList æC Basic Class Documentation ODWindowState maintains a list of windows, and some menu bar information. Each OpenDoc process has access to a single ODWindowState object, obtained from the ODSession object. ODWindowState is a derived class of ODObject. ODWindowState is implemented by platform vendors. Much of this class is platform-independent, but it contains platform-specific menu information, in addition to the window list. Related classes are ODWindow and ODWindowIterator. ODWindowState participates in the Part Activation and UI Events protocols. Theory of Operation ODWindow State contains a list of windows for all open document drafts in an OpenDoc session. The standard OpenDoc shell application will have one open document, but multiple drafts of that document may be open. Traditional applications which have been modified to support embedding may have multiple documents open. The primary purpose of the window state is to assist in event distribution. The order of the windows in the list is insignificant. The elements in the list of windows are instances of class ODWindow which is also part of the OpenDoc API, so parts can call methods of ODWindow directly. Invariants Maintained by Class ODWindowState contains a list of ODWindow objects. ODWindowState also contains the base menu bar object. Other Persistent Properties Although ODWindow is not an ODPersistentObject, the WindowState stored windows persistently in a special draft property. æKY ODWindowState::ODWindowState WindowState::ODWindowState WindowState->ODWindowState æT Class Method æD ODWindowState(); æC Protection Public. A WindowState is created by the OpenDoc session object. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Constructs the instance, setting fields to null values. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions None. Post conditions The window state is constructed, but not usable until InitWindowState is called. æKY ODWindowState::~ODWindowState WindowState::~ODWindowState WindowState->~ODWindowState æT Class Method æD ~ODWindowState(); æC Protection Public. The window state is destroyed by the OpenDoc session object. Override policy Derived class cannot override. Derived class cannot call base class behavior, during derived class behavior. Basic operation Frees the memory allocated by this instance. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions A constructed instance. Post conditions The memory used by this class is freed. æKY ODWindowState::AcquireActiveWindow WindowState::AcquireActiveWindow WindowState->AcquireActiveWindow æT Class Method æD ODWindow* AcquireActiveWindow(); æC Protection Public. Used by the dispatcher. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the front-most window which is not a "floating" window. Inputs None. Outputs <return> The active window Exceptions Signalled None. Pre conditions Avalid initialized instance. Post conditions No effect on this instance. æKY ODWindowState::AcquireBaseMenuBar WindowState::AcquireBaseMenuBar WindowState->AcquireBaseMenuBar æT Class Method æD ODMenuBar* AcquireBaseMenuBar(); æC Protection Public. Public, for use by shell. Parts typically call CopyBaseMenuBar Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns a reference to the current menu bar. Inputs None. Outputs <return> Reference to current base menu bar Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions No effect on this instance. æKY ODWindowState::AcquireCurrentMenuBar WindowState::AcquireCurrentMenuBar WindowState->AcquireCurrentMenuBar æT Class Method æD ODMenuBar* AcquireCurrentMenuBar(); æC Protection Public. Public, for use by shell. Parts typically call CopyBaseMenuBar. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns a reference to the current menu bar. Inputs None. Outputs <return> Reference to current menu bar Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions No effect on this instance. æKY ODWindowState::AcquireFrontFloatingWindow WindowState::AcquireFrontFloatingWindow WindowState->AcquireFrontFloatingWindow æT Class Method æD ODWindow* AcquireFrontFloatingWindow(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the front floating window. If there is no such window, kODNULL is returned. Inputs None. Outputs <return> Front floating window. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions No effect on this instance. æKY ODWindowState::AcquireFrontRootWindow WindowState::AcquireFrontRootWindow WindowState->AcquireFrontRootWindow æT Class Method æD ODWindow* AcquireFrontRootWindow(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the front non-floating root document window. If there is no such window, kODNULL is returned. Inputs None. Outputs <return> Front non-floating root document window Exceptions Signalled None. Pre conditions A valid initialized instance Post conditions No effect on this instance. æKY ODWindowState::AcquireFrontWindow WindowState::AcquireFrontWindow WindowState->AcquireFrontWindow æT Class Method æD ODWindow* AcquireFrontWindow(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the front non-floating document window. If there is no such window, kODNULL is returned. Inputs None. Outputs <return> First document window. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODWindowState::AcquireODWindow WindowState::AcquireODWindow WindowState->AcquireODWindow æT Class Method æD ODWindow* AcquireODWindow( ODPlatformWindow window); æC Protection Public. Called mostly by the dispatcher. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the ODWindow object corresponding to the specified platform-specific window object, or kODNULL. Inputs window A platform-specific window object Outputs <return> The corresponding OpenDoc window, or kODNULL if the specified window is not an OpenDoc window Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions No effect on this instance. æKY ODWindowState::AcquireWindow WindowState::AcquireWindow WindowState->AcquireWindow æT Class Method æD ODWindow* AcquireWindow( ODID id); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the window object with the given ID, or kODNULL if the window has been destroyed or never existed. Note that these are not persistent IDs, but are valid for a session. Inputs id A window ID, obtained from a window using ODWindow::GetID. Outputs <return> The window matching the specified ID, or kODNULL. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions No effect on this instance. æKY ODWindowState::ActivateFrontWindows WindowState::ActivateFrontWindows WindowState->ActivateFrontWindows æT Class Method æD void ActivateFrontWindows(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Activates all the floating windows and the first Document window. This should be called after a modal dialog has been dismissed. DeactivateFrontWindows should be called before the modal dialog is displayed. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions DeactivateFrontWindows has been called to deactivate all the floating windows and the first Document window. Post conditions All the floating windows and the firstDocument window should be active. æKY ODWindowState::AdjustPartMenus WindowState::AdjustPartMenus WindowState->AdjustPartMenus æT Class Method æD void AdjustPartMenus(); æC Protection Public. Called when the user clicks in the menu bar. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Calls Part::AdjustMenus for the part with the menu focus, so that it can enable/disable menu items as necessary. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions Menus are set up by part with menu focus. æKY ODWindowState::CloseWindows WindowState::CloseWindows WindowState->CloseWindows æT Class Method æD void CloseWindows( ODDraft* draft); æC Protection Public. Called by the OpenDoc shell when closing a draft. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Closes all windows belonging to the specified draft. Inputs draft An open OpenDoc draft Outputs None. Exceptions Signalled kODErrInvalidDraft The specified draft is not valid. Pre conditions A valid open draft object. Post conditions All windows of the specified draft are closed. æKY ODWindowState::CopyBaseMenuBar WindowState::CopyBaseMenuBar WindowState->CopyBaseMenuBar æT Class Method æD ODMenuBar* CopyBaseMenuBar(); æC Protection Public. Called by Part Editors. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns a copy of the base menu bar. Called by part editors to create a menu bar to which they add their own menus. Inputs None. Outputs <return> Copy of base menu bar Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions No effect on this instance. æKY ODWindowState::CreateCanvas WindowState::CreateCanvas WindowState->CreateCanvas æT Class Method æD ODCanvas* CreateCanvas( ODGraphicsSystem graphicsSystem, ODPlatformCanvs platformCanvas, ODBoolean isDynamic, ODBoolean isOffscreen); æC Protection Public. Called by parts to obtain canvas objects. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Create and return a canvas object with the specified parameters. Inputs graphicsSystem graphicsSystem setting of the canvas. platformCanvas platformCanvas for the canvas. isDynamic isDynamic setting of the canvas. isOffscreen isOffscreen setting of the canvas. Outputs <return> The new canvas. Exceptions Signalled None. Pre conditions None. Post conditions None. æKY ODWindowState::CreateMenuBar WindowState::CreateMenuBar WindowState->CreateMenuBar æT Class Method æD ODMenuBar CreateMenuBar( in ODPlatformMenuBar menuBar); æC Protection Public. Called by shell. Parts generally call CopyBaseMenuBar. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Creates and initializes an ODMenuBar. Inputs menuBar The platform-specific menu bar object. Outputs <return> <return> Exceptions Signalled None. Pre conditions An initialized ODWindowState Post conditions Result contains a valid ODMenuBar æKY ODWindowState::CreateWindowIterator WindowState::CreateWindowIterator WindowState->CreateWindowIterator æT Class Method æD ODWindowIterator* CreateWindowIterator(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns an iterator for all the windows (of all drafts) in the window state. Inputs None. Outputs <return> The iterator Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions No effect on this instance. æKY ODWindowState::DeactivateFrontWindows WindowState::DeactivateFrontWindows WindowState->DeactivateFrontWindows æT Class Method æD void DeactivateFrontWindows(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Deactivates all the floating windows and the first Document window. This should be called before a modal dialog is brought up. Inputs None. Outputs None. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions All the floating windows and the firstDocument window should be deactivated. æKY ODWindowState::Externalize WindowState::Externalize WindowState->Externalize æT Class Method æD void Externalize( ODDraft* draft); æC Protection Public. Called by the OpenDoc shell when saving a draft. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Saves all windows belonging to the specified draft in the draft. Inputs draft An open OpenDoc draft Outputs None. Exceptions Signalled kODErrInvalidDraft The specified draft is not valid. Pre conditions A valid open draft object. Post conditions The draft contains the IDs of the windows that were saved in the draft. æKY ODWindowState::GetRootWindowCount WindowState::GetRootWindowCount WindowState->GetRootWindowCount æT Class Method æD ODUShort GetRootWindowCount( ODDraft* draft); æC Protection Public. Used by the document shell when closing a window, to determine when to close the draft. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the number of root windows belonging to the specified draft. Inputs None. Outputs <return> The number of root windows belonging to the specified draft. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions No effect on this instance. æKY ODWindowState::GetTotalRootWindowCount WindowState::GetTotalRootWindowCount WindowState->GetTotalRootWindowCount æT Class Method æD ODUShort GetTotalRootWindowCount(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the number of root windows of all drafts. Inputs None. Outputs <return> The number of root windows of all drafts Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions No effect on this instance. æKY ODWindowState::GetWindowCount WindowState::GetWindowCount WindowState->GetWindowCount æT Class Method æD ODULong GetWindowCount(); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns the number of windows in the window state (regardless of draft) Inputs None. Outputs <return> The number of OpenDoc windows in the WindowState. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions No effect on this instance. æKY ODWindowState::InitWindowState WindowState::InitWindowState WindowState->InitWindowState æT Class Method æD InitWindowState( ODSession* session); æC Protection Public. A WindowState is created by the OpenDoc session object. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Initializes the WindowState. Inputs session A reference to the OpenDoc session object. Outputs None. Exceptions Signalled None. Pre conditions A constructed instance. Post conditions The window state is ready for use. æKY ODWindowState::Internalize WindowState::Internalize WindowState->Internalize æT Class Method æD void Internalize( ODDraft* draft); æC Protection Public. Called by the OpenDoc shell when a draft is opened. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Adds to the window state all windows persistently stored in the specified draft. Inputs draft An open OpenDoc draft. Outputs None. Exceptions Signalled kODErrInvalidDraft The specified draft is not valid. kODErrOutOfMemory Out of memory Pre conditions A valid open draft object. Post conditions The window state contains all the windows that were saved in the draft. æKY ODWindowState::IsODWindow WindowState::IsODWindow WindowState->IsODWindow æT Class Method æD ODBoolean IsODWindow( ODPlatformWindow window); æC Protection Public. Called mostly by the dispatcher. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Returns true if the specified platform-specific window is an OpenDoc window. Inputs window A platform-specific window object Outputs <return> kODTrue, if the window is an OpenDoc window Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions No effect on this instance. æKY ODWindowState::OpenWindows WindowState::OpenWindows WindowState->OpenWindows æT Class Method æD void OpenWindows( ODDraft* draft); æC Protection Public. Called by the OpenDoc shell. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Opens all windows stored in the specified draft, and shows those that were visible when saved. Inputs draft An open OpenDoc draft. Outputs None. Exceptions Signalled kODErrInvalidDraft The specified draft is not valid. kODErrOutOfMemory Out of memory Pre conditions A valid open draft object. The WindowState has already Internalized the windows of the specified draft. Post conditions The windows of the specified draft are open. æKY ODWindowState::Purge WindowState::Purge WindowState->Purge æT Class Method æD ODSize Purge( ODSize size); æC Protection Public. Called by OpenDoc. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Frees up some memory, by deleting cached values which can be recomputed or restored from persistent storage. Inputs size The amount of memory requested. Outputs <return> The amount of memory freed. Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions Some memory has been freed up. æKY ODWindowState::RegisterWindow WindowState::RegisterWindow WindowState->RegisterWindow æT Class Method æD ODWindow* RegisterWindow( ODPlatformWindow platformWindow, ODType frameType, ODBoolean isRootWindow, ODBoolean isResizable, ODBoolean isFloating, ODBoolean shouldSave, ODPart* rootPart, ODTypeToken viewType, ODTypeToken presentation, ODFrame* sourceFrame); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Creates and initializes a window object for a given platform window, and registers it to the WindowState. The supplied platform window should be created invisble. Calls to RegisterWindow are usually followed by Open(), Show() and Select() calls. Inputs platformWindow A pointer to a platform-specific window structure isRootWindow Does this window "keep the document open". kODFalse for dialog and other auxiliary windows. isResizable kODTrue, if the window is resizable by the user. isFloating kODTrue if the window shouldalways float above others. shouldSave kODTrue if the window state should save this window persistently in the document. rootPart The part associated with the root frame of the window. viewType The view type for the root frame of the window. See ODFrame. presentation The presentation type for the root frame. See ODFrame. sourceFrame The frame from which this window was opened. Can be kODNull. frameType The type which should be used to create the root frame of the window (kODFrameObject or kODNonPersistentFrameObject). Outputs <return> The new window Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions The newly-created window is in the window state. æKY ODWindowState::RegisterWindowForFrame WindowState::RegisterWindowForFrame WindowState->RegisterWindowForFrame æT Class Method æD ODWindow RegisterWindowForFrame( in ODPlatformWindow newWindow, in ODFrame frame, in ODBoolean isRootWindow, in ODBoolean isResizable, in ODBoolean isFloating, in ODBoolean shouldSave, in ODFrame sourceFrame); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Creates and initializes a window object for a given platform window and root frame, and registers it to the WindowState. The supplied platform window should be created invisble. Calls to RegisterWindowForFrame are usually followed by Open(), Show() and Select() calls. Inputs newWindow A pointer to a platform-specific window structure isRootWindow Does this window "keep the document open". kODFalse for dialog and other auxiliary windows. isResizable kODTrue, if the window is resizable by the user. isFloating kODTrue if the window shouldalways float above others. shouldSave kODTrue if the window state should save this window persistently in the document. sourceFrame The frame from which this window was opened. Can be kODNull. frame The root frame for this window Outputs <return> The new window Exceptions Signalled None. Pre conditions A valid initialized instance. Post conditions The newly-created window is in the window state. æKY ODWindowState::SetBaseMenuBar WindowState::SetBaseMenuBar WindowState->SetBaseMenuBar æT Class Method æD void SetBaseMenuBar( ODMenuBar* menuBar); æC Protection Public. Called by the OpenDoc shell application Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Stores the base menu bar created by the shell. Parts call CopyBaseMenuBar to create a menu bar to which they add their own menus. Inputs menuBar Reference to base menu bar object Outputs None. Exceptions Signalled None. Pre conditions A valid initialized instance Post conditions Field is set. æKY ODWindowState::SetCurrentMenuBar WindowState::SetCurrentMenuBar WindowState->SetCurrentMenuBar æT Class Method æD void SetCurrentMenuBar( ODMenuBar* menuBar); æC Protection Public. Private to UI subsystem. Called by ODMenuBar::Display Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Stores the reference to the current menu bar. Inputs menuBar Reference to a menu bar Outputs None. Exceptions Signalled None. Pre conditions A constructed object of this class. Post conditions Stored current menu bar reference has been changed. æKY ODWindowState::SetDefaultWindowTitles WindowState::SetDefaultWindowTitles WindowState->SetDefaultWindowTitles æT Class Method æD void SetDefaultWindowTitles( ODDraft* draft); æC Protection Public. Override policy Derived class can override. Derived class can call base class behavior, during derived class behavior. Basic operation Synchronizes window titles with the file name. Inputs draft An open OpenDoc draft Outputs None. Exceptions Signalled kODErrInvalidDraft The specified draft is not valid. Pre conditions A valid open draft object. Post conditions The window titles are synchronized with the file name. æKY ODWindowState::fBaseMenuBar WindowState::fBaseMenuBar æT Class Field æD ODMenuBar* fBaseMenuBar; æC Persistent form None. æKY ODWindowState::fCurrentMenuBar WindowState::fCurrentMenuBar æT Class Field æD ODMenuBar* fCurrentMenuBar; æC Persistent form None. æKY ODWindowState::fNextID WindowState::fNextID æT Class Field æD ODID fNextID; æC æKY ODWindowState::fSession WindowState::fSession æT Class Field æD ODSession* fSession; æC Persistent form None. æKY ODWindowState::fWindowList WindowState::fWindowList æT Class Field æD OrderedCollection* fWindowList; æC